{ "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.globalaccelerator#Accelerator": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "
The Amazon Resource Name (ARN) of the accelerator.
" } }, "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the accelerator. The name must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" } }, "IpSets": { "target": "com.amazonaws.globalaccelerator#IpSets", "traits": { "smithy.api#documentation": "The static IP addresses that Global Accelerator associates with the accelerator.
" } }, "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\nThe naming convention for the DNS name for an accelerator is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both \n \t\t\tthe A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { "target": "com.amazonaws.globalaccelerator#AcceleratorStatus", "traits": { "smithy.api#documentation": "Describes the deployment status of the accelerator.
" } }, "CreatedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the accelerator was created.
" } }, "LastModifiedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the accelerator was last modified.
" } }, "DualStackDnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:\n\t\t\ttwo IPv4 addresses and two IPv6 addresses.
\nThe naming convention for the dual-stack DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.dualstack.awsglobalaccelerator.com.
\nNote: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
For more information, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Events": { "target": "com.amazonaws.globalaccelerator#AcceleratorEvents", "traits": { "smithy.api#documentation": "A history of changes that you make to an accelerator in Global Accelerator.
" } } }, "traits": { "smithy.api#documentation": "An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct\n\t\t\ttraffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
" } }, "com.amazonaws.globalaccelerator#AcceleratorAttributes": { "type": "structure", "members": { "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\ns3-bucket_name//AWSLogs/aws_account_id
" } } }, "traits": { "smithy.api#documentation": "Attributes of an accelerator.
" } }, "com.amazonaws.globalaccelerator#AcceleratorEvent": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "A string that contains an Event message describing changes or errors\n\t\t\twhen you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains a Timestamp value and Message for changes \n\t\t\tthat you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when \n\t\t\tyou update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum \n\t\t\tof ten event messages.
The accelerator that you specified could not be disabled.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#AcceleratorNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The accelerator that you specified doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#AcceleratorStatus": { "type": "enum", "members": { "DEPLOYED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } } } }, "com.amazonaws.globalaccelerator#Accelerators": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Accelerator" } }, "com.amazonaws.globalaccelerator#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You don't have access permission.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.globalaccelerator#AddCustomRoutingEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ConflictException" }, { "target": "com.amazonaws.globalaccelerator#EndpointAlreadyExistsException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
\nThe listener port range must be large enough to support the number of IP addresses that can be \n\t\tspecified in your subnet. The number of ports required is: subnet size times the number\n\t\tof ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener \n\t\tport range of at least 255 ports.
\nNote: You must have enough remaining listener ports available to \n\t\tmap to the subnet ports, or the call will fail with a LimitExceededException.
\nBy default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all\n\t\t\tdestinations to receive traffic, or to specify individual port mappings that can receive\n\t\t\ttraffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
" } }, "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsRequest": { "type": "structure", "members": { "EndpointConfigurations": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointConfigurations", "traits": { "smithy.api#documentation": "The list of endpoint objects to add to a custom routing accelerator.
", "smithy.api#required": {} } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsResponse": { "type": "structure", "members": { "EndpointDescriptions": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointDescriptions", "traits": { "smithy.api#documentation": "The endpoint objects added to the custom routing accelerator.
" } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AddEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#AddEndpointsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#AddEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The\n\t\t\talternative options are to add endpoints when you create an endpoint group (with the\n\t\t\tCreateEndpointGroup API) \n\t\t\tor when you update an endpoint group (with the \n\t\t\tUpdateEndpointGroup API).
There are two advantages to using AddEndpoints to add endpoints in Global Accelerator:
It's faster, because Global Accelerator only has to resolve the new endpoints that\n\t\t\t\t\tyou're adding, rather than resolving new and existing endpoints.
\nIt's more convenient, because you don't need to specify the current \n\t\t\t\t\tendpoints that are already in the endpoint group, in addition to the new endpoints that \n\t\t\t\t\tyou want to add.
\nFor information about endpoint types and requirements for endpoints that you can add\n\t\t\tto Global Accelerator, see \n\t\t\t\tEndpoints for standard accelerators in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#AddEndpointsRequest": { "type": "structure", "members": { "EndpointConfigurations": { "target": "com.amazonaws.globalaccelerator#EndpointConfigurations", "traits": { "smithy.api#documentation": "The list of endpoint objects.
", "smithy.api#required": {} } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AddEndpointsResponse": { "type": "structure", "members": { "EndpointDescriptions": { "target": "com.amazonaws.globalaccelerator#EndpointDescriptions", "traits": { "smithy.api#documentation": "The list of endpoint objects.
" } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidr": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#AdvertiseByoipCidrRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#AdvertiseByoipCidrResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ByoipCidrNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#IncorrectCidrStateException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP). It can take a few minutes before traffic to \n\t\t\tthe specified addresses starts routing to Amazon Web Services because of propagation delays.
\nTo stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.
\nFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidrRequest": { "type": "structure", "members": { "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The address range, in CIDR notation. This must be the exact range that you provisioned. \n\t\t\tYou can't advertise only a portion of the provisioned range.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidrResponse": { "type": "structure", "members": { "ByoipCidr": { "target": "com.amazonaws.globalaccelerator#ByoipCidr", "traits": { "smithy.api#documentation": "Information about the address range.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AllowCustomRoutingTraffic": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#AllowCustomRoutingTrafficRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic \n\t\t\tfor a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a\n\t\t\tspecified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports \n\t\t\toutside of the range that you configured for the endpoint group.
\nAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" } }, "com.amazonaws.globalaccelerator#AllowCustomRoutingTrafficRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
", "smithy.api#required": {} } }, "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
", "smithy.api#required": {} } }, "DestinationAddresses": { "target": "com.amazonaws.globalaccelerator#DestinationAddresses", "traits": { "smithy.api#documentation": "A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive \n\t\t\ttraffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
\n\n DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is\n\t\tnot specified.
A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
" } }, "AllowAllTrafficToEndpoint": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic \n\t\t\tfrom a custom routing accelerator. The value is TRUE or FALSE.
\nWhen set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\nWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed\n\t\t\tto receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\nThe default value is FALSE.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AssociatedEndpointGroupFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The listener that you specified has an endpoint group associated with it. You must remove all dependent resources\n\t\t\tfrom a listener before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#AssociatedListenerFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an\n\t\t\taccelerator before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#Attachment": { "type": "structure", "members": { "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cross-account attachment.
" } }, "Name": { "target": "com.amazonaws.globalaccelerator#AttachmentName", "traits": { "smithy.api#documentation": "The name of the cross-account attachment.
" } }, "Principals": { "target": "com.amazonaws.globalaccelerator#Principals", "traits": { "smithy.api#documentation": "The principals included in the cross-account attachment.
" } }, "Resources": { "target": "com.amazonaws.globalaccelerator#Resources", "traits": { "smithy.api#documentation": "The resources included in the cross-account attachment.
" } }, "LastModifiedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the cross-account attachment was last modified.
" } }, "CreatedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the cross-account attachment was created.
" } } }, "traits": { "smithy.api#documentation": "A cross-account attachment in Global Accelerator. A cross-account attachment\n\t\t\tspecifies the principals who have permission to work with resources \n\t\t\tin your account, which you also list in the attachment.
" } }, "com.amazonaws.globalaccelerator#AttachmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^[\\S\\s]+$" } }, "com.amazonaws.globalaccelerator#AttachmentNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "No cross-account attachment was found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#Attachments": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Attachment" } }, "com.amazonaws.globalaccelerator#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.globalaccelerator#AwsAccountIds": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#AwsAccountId" } }, "com.amazonaws.globalaccelerator#ByoipCidr": { "type": "structure", "members": { "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The address range, in CIDR notation.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
" } }, "State": { "target": "com.amazonaws.globalaccelerator#ByoipCidrState", "traits": { "smithy.api#documentation": "The state of the address pool.
" } }, "Events": { "target": "com.amazonaws.globalaccelerator#ByoipCidrEvents", "traits": { "smithy.api#documentation": "A history of status changes for an IP address range that you bring to Global Accelerator\n\t\t\tthrough bring your own IP address (BYOIP).
" } } }, "traits": { "smithy.api#documentation": "Information about an IP address range that is provisioned for use with your Amazon Web Services resources through \n\t\t\tbring your own IP address (BYOIP).
\nThe following describes each BYOIP State that your IP address range can be in.
\n PENDING_PROVISIONING \u2014 \n\t\t\t\tYou\u2019ve submitted a request to provision an IP address range but it is not yet provisioned with \n\t\t\t Global Accelerator.
\n\n READY \u2014 The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.
\n\n PENDING_ADVERTISING \u2014 You\u2019ve submitted a \n\t\t\t request for Global Accelerator to advertise an address range but it is not yet being advertised.
\n\n ADVERTISING \u2014 The address range is \n\t\t\t being advertised by Global Accelerator.
\n\n PENDING_WITHDRAWING \u2014 You\u2019ve submitted \n\t\t\t\ta request to withdraw an address range from being advertised but it is still being advertised \n\t\t\t\tby Global Accelerator.
\n\n PENDING_DEPROVISIONING \u2014 You\u2019ve submitted a \n\t\t\t request to deprovision an address range from Global Accelerator but it is still provisioned.
\n\n DEPROVISIONED \u2014 The address range is deprovisioned \n\t\t\t from Global Accelerator.
\n\n FAILED_PROVISION \u2014 The request to \n\t\t\t provision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_ADVERTISING \u2014 The request for Global Accelerator\n\t\t\t\tto advertise the address range was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_WITHDRAW \u2014 The request to withdraw \n\t\t\t the address range from advertising by Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_DEPROVISION \u2014 The request to \n\t\t\t deprovision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\nA string that contains an Event message describing changes that you make in the status \n\t\t\tof an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through \n\t\t\tbring your own IP address (BYOIP).
" } } }, "traits": { "smithy.api#documentation": "A complex type that contains a Message and a Timestamp value for changes \n\t\t\tthat you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP \n\t\t\taddress (BYOIP).
The CIDR that you specified was not found or is incorrect.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#ByoipCidrState": { "type": "enum", "members": { "PENDING_PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_PROVISIONING" } }, "READY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READY" } }, "PENDING_ADVERTISING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ADVERTISING" } }, "ADVERTISING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADVERTISING" } }, "PENDING_WITHDRAWING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_WITHDRAWING" } }, "PENDING_DEPROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DEPROVISIONING" } }, "DEPROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPROVISIONED" } }, "FAILED_PROVISION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_PROVISION" } }, "FAILED_ADVERTISING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_ADVERTISING" } }, "FAILED_WITHDRAW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_WITHDRAW" } }, "FAILED_DEPROVISION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_DEPROVISION" } } } }, "com.amazonaws.globalaccelerator#ByoipCidrs": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#ByoipCidr" } }, "com.amazonaws.globalaccelerator#CidrAuthorizationContext": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The plain-text authorization message for the prefix and account.
", "smithy.api#required": {} } }, "Signature": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The signed authorization message for the prefix and account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services \n\t\t\taccount using bring your own IP addresses (BYOIP).
\nFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ClientAffinity": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "SOURCE_IP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_IP" } } } }, "com.amazonaws.globalaccelerator#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You can't use both of those options.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.globalaccelerator#CreateAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\n\t\t\tto one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton Amazon Web Services CLI commands.
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
", "smithy.api#required": {} } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\nAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t \tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t \tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t \tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\nYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\nNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\nFor more information, see Bring \n\t\t your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\t\tuniqueness\u2014of an accelerator.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { "smithy.api#documentation": "Create tags for an accelerator.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#Accelerator", "traits": { "smithy.api#documentation": "The accelerator that is created by specifying a listener and the supported IP address types.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCrossAccountAttachment": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateCrossAccountAttachmentRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateCrossAccountAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to\n\t\t\tspecify the principals who have permission to work with resources\n\t\t\tin accelerators in their own account. You specify, in the same attachment, the resources that are shared.
\nA principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an \n\t\t\taccelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment,\n\t\t\tyou must sign in to an account specified as a principal. Then, you can work with resources that are listed, \n\t\t\twith any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, \n\t\t\tanyone with permission to make updates to the accelerator can work with resources that are listed in the \n\t\t\tattachment.
\nSpecify each principal and resource separately. To specify two CIDR address pools, list\n\t\t\tthem individually under Resources, and so on. For a command line operation, for example,\n\t\t\tyou might use a statement like the following:
\n \"Resources\": [{\"Cidr\": \"169.254.60.0/24\"},{\"Cidr\": \"169.254.59.0/24\"}]\n
For more information, see \n\t\t\tWorking with cross-account attachments and resources in Global Accelerator in the \n\t\t\t\tGlobal Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#CreateCrossAccountAttachmentRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.globalaccelerator#AttachmentName", "traits": { "smithy.api#documentation": "The name of the cross-account attachment.
", "smithy.api#required": {} } }, "Principals": { "target": "com.amazonaws.globalaccelerator#Principals", "traits": { "smithy.api#documentation": "The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account\n\t\t\tnumber or the Amazon Resource Name (ARN) for an accelerator.
" } }, "Resources": { "target": "com.amazonaws.globalaccelerator#Resources", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can\n\t\t\tbe any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a\n\t\t\tbring your own IP address (BYOIP) address pool.
" } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\t\tuniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { "smithy.api#documentation": "Add tags for a cross-account attachment.
\nFor more information, see Tagging\n\t\t\tin Global Accelerator in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCrossAccountAttachmentResponse": { "type": "structure", "members": { "CrossAccountAttachment": { "target": "com.amazonaws.globalaccelerator#Attachment", "traits": { "smithy.api#documentation": "Information about the cross-account attachment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands\n\t of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
\nBe aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive\n\t\t\ttraffic. To enable all destinations to receive traffic, or to specify individual port\n\t\t\tmappings that can receive traffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\ton Amazon Web Services CLI commands.
The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain \n\t\tonly alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
", "smithy.api#required": {} } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\nAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t\t\tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t\t\tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t\t\tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\nYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\nNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\nFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that\n\t\t\tis, the uniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { "smithy.api#documentation": "Create tags for an accelerator.
\nFor more information, see Tagging\n\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAccelerator", "traits": { "smithy.api#documentation": "The accelerator that is created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupAlreadyExistsException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidPortRangeException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Create an endpoint group for the specified listener for a custom routing accelerator. \n\t An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\tRegion.
" } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
", "smithy.api#required": {} } }, "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\tspecific Region.
", "smithy.api#required": {} } }, "DestinationConfigurations": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationConfigurations", "traits": { "smithy.api#documentation": "Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept \n\t\tclient traffic on.
", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\tuniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupResponse": { "type": "structure", "members": { "EndpointGroup": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroup", "traits": { "smithy.api#documentation": "The information about the endpoint group created for a custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidPortRangeException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Create a listener to process inbound connections from clients to a custom routing accelerator.\n\t\t\tConnections arrive to assigned static IP addresses on the port range that you specify.
" } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingListenerRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
", "smithy.api#required": {} } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\tuniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingListenerResponse": { "type": "structure", "members": { "Listener": { "target": "com.amazonaws.globalaccelerator#CustomRoutingListener", "traits": { "smithy.api#documentation": "The listener that you've created for a custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateEndpointGroupRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateEndpointGroupResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupAlreadyExistsException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\t\tRegion. A resource must be valid and active when you add it as an endpoint.
\nFor more information about endpoint types and requirements for endpoints that you can add\n\t\t\t\tto Global Accelerator, see \n\t\t\t\t\tEndpoints for standard accelerators in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#CreateEndpointGroupRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", "smithy.api#required": {} } }, "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\t\tspecific Region.
", "smithy.api#required": {} } }, "EndpointConfigurations": { "target": "com.amazonaws.globalaccelerator#EndpointConfigurations", "traits": { "smithy.api#documentation": "The list of endpoint objects.
" } }, "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { "smithy.api#documentation": "The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the\n\t\t\tfirst port in the list.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { "smithy.api#documentation": "The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" } }, "HealthCheckPath": { "target": "com.amazonaws.globalaccelerator#HealthCheckPath", "traits": { "smithy.api#documentation": "If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).
" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "The time\u201410 seconds or 30 seconds\u2014between each health check for an endpoint. The default value is 30.
" } }, "ThresholdCount": { "target": "com.amazonaws.globalaccelerator#ThresholdCount", "traits": { "smithy.api#documentation": "The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.
" } }, "IdempotencyToken": { "target": "com.amazonaws.globalaccelerator#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\t\tuniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateEndpointGroupResponse": { "type": "structure", "members": { "EndpointGroup": { "target": "com.amazonaws.globalaccelerator#EndpointGroup", "traits": { "smithy.api#documentation": "The information about the endpoint group that was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#CreateListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#CreateListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidPortRangeException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static\n\t\t\tIP addresses on a port, port range, or list of port ranges that you specify.
" } }, "com.amazonaws.globalaccelerator#CreateListenerRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of your accelerator.
", "smithy.api#required": {} } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The list of port ranges to support for connections from clients to your accelerator.
", "smithy.api#required": {} } }, "Protocol": { "target": "com.amazonaws.globalaccelerator#Protocol", "traits": { "smithy.api#documentation": "The protocol for connections from clients to your accelerator.
", "smithy.api#required": {} } }, "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties\u2014source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol\u2014to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties\u2014\n\t\t\tsource (client) IP address and destination IP address\u2014to select the hash value.
The default value is NONE.
A unique, case-sensitive identifier that you provide to ensure the idempotency\u2014that is, the\n\t\t\tuniqueness\u2014of the request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateListenerResponse": { "type": "structure", "members": { "Listener": { "target": "com.amazonaws.globalaccelerator#Listener", "traits": { "smithy.api#documentation": "The listener that you've created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CrossAccountResource": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The endpoint ID for the endpoint that is listed in a cross-account attachment and\n\t\t\tcan be added to an accelerator by specified principals.
" } }, "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must\n\t\t\tbe provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process \n\t\t\tfor Global Accelerator.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
" } }, "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or\n\t\t\tCIDR range) that can be added to accelerators and principals that have permission to add them.
" } } }, "traits": { "smithy.api#documentation": "An endpoint (Amazon Web Services resource) or an IP address range, in CIDR format, that is \n\t\t\tlisted in a cross-account attachment. A cross-account resource can be added to an accelerator by \n\t\t\tspecified principals, which are also listed in the attachment.
\nFor more information, see \n\t\t\tWorking with cross-account attachments and resources in Global Accelerator in the \n\t\t\t\tGlobal Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#CrossAccountResources": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CrossAccountResource" } }, "com.amazonaws.globalaccelerator#CustomRoutingAccelerator": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom routing accelerator.
" } }, "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the accelerator. The name must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" } }, "IpSets": { "target": "com.amazonaws.globalaccelerator#IpSets", "traits": { "smithy.api#documentation": "The static IP addresses that Global Accelerator associates with the accelerator.
" } }, "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\nThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record \n\t\t\tand the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAcceleratorStatus", "traits": { "smithy.api#documentation": "Describes the deployment status of the accelerator.
" } }, "CreatedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the accelerator was created.
" } }, "LastModifiedTime": { "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the accelerator was last modified.
" } } }, "traits": { "smithy.api#documentation": "Attributes of a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingAcceleratorAttributes": { "type": "structure", "members": { "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\nDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" } } }, "traits": { "smithy.api#documentation": "Attributes of a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingAcceleratorStatus": { "type": "enum", "members": { "DEPLOYED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } } } }, "com.amazonaws.globalaccelerator#CustomRoutingAccelerators": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAccelerator" } }, "com.amazonaws.globalaccelerator#CustomRoutingDestinationConfiguration": { "type": "structure", "members": { "FromPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
", "smithy.api#required": {} } }, "ToPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
", "smithy.api#required": {} } }, "Protocols": { "target": "com.amazonaws.globalaccelerator#CustomRoutingProtocols", "traits": { "smithy.api#documentation": "The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual\n\t\t\tprivate cloud subnets) in an endpoint group to accept client traffic on.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingDestinationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.globalaccelerator#CustomRoutingDestinationDescription": { "type": "structure", "members": { "FromPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
" } }, "ToPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
" } }, "Protocols": { "target": "com.amazonaws.globalaccelerator#Protocols", "traits": { "smithy.api#documentation": "The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
" } } }, "traits": { "smithy.api#documentation": "For a custom routing accelerator, describes the port range and protocol for all endpoints\n\t\t\t(virtual private cloud subnets) in an endpoint group to accept client traffic on.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingDestinationDescriptions": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationDescription" } }, "com.amazonaws.globalaccelerator#CustomRoutingDestinationTrafficState": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENY" } } } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointConfiguration": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)\n\t\t\tsubnet ID.
" } }, "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources)\n\t\t\tthat can be added to accelerators and principals that have permission to add the endpoints.
" } } }, "traits": { "smithy.api#documentation": "The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointConfigurations": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointDescription": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)\n\t\t\tsubnet ID.
" } } }, "traits": { "smithy.api#documentation": "A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, \n\t\t\twhich are virtual private cloud (VPC) subnets.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointDescriptions": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointDescription" } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroup": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } }, "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located.
" } }, "DestinationDescriptions": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationDescriptions", "traits": { "smithy.api#documentation": "For a custom routing accelerator, describes the port range and protocol for all endpoints\n\t\t\t(virtual private cloud subnets) in an endpoint group to accept client traffic on.
" } }, "EndpointDescriptions": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointDescriptions", "traits": { "smithy.api#documentation": "For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an\n\t\t\tendpoint group to accept client traffic on.
" } } }, "traits": { "smithy.api#documentation": "A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.\n\t\t
" } }, "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroups": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroup" } }, "com.amazonaws.globalaccelerator#CustomRoutingListener": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
" } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\t\t\tendpoints for custom routing accelerators.
" } } }, "traits": { "smithy.api#documentation": "A complex type for a listener for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#CustomRoutingListeners": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingListener" } }, "com.amazonaws.globalaccelerator#CustomRoutingProtocol": { "type": "enum", "members": { "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP" } }, "UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UDP" } } } }, "com.amazonaws.globalaccelerator#CustomRoutingProtocols": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#CustomRoutingProtocol" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.globalaccelerator#DeleteAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteAcceleratorRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotDisabledException" }, { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AssociatedListenerFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. \n\t\t
\nThe IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nThe Amazon Resource Name (ARN) of an accelerator.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCrossAccountAttachment": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteCrossAccountAttachmentRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#AttachmentNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission\n\t\t\tto use the resources in the attachment from all principals in the list of principals. Global Accelerator \n\t\t\trevokes the permission for specific resources.
\nFor more information, see \n\t\t\tWorking with cross-account attachments and resources in Global Accelerator in the \n\t\t\t\tGlobal Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#DeleteCrossAccountAttachmentRequest": { "type": "structure", "members": { "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the cross-account attachment to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingAcceleratorRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotDisabledException" }, { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AssociatedListenerFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t
\nThe IP \n\t\t\taddresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nThe Amazon Resource Name (ARN) of the custom routing accelerator to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingEndpointGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Delete an endpoint group from a listener for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingEndpointGroupRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingListenerRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AssociatedEndpointGroupFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Delete a listener for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteEndpointGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Delete an endpoint group from a listener.
" } }, "com.amazonaws.globalaccelerator#DeleteEndpointGroupRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeleteListenerRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AssociatedEndpointGroupFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Delete a listener from an accelerator.
" } }, "com.amazonaws.globalaccelerator#DeleteListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DenyCustomRoutingTraffic": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DenyCustomRoutingTrafficRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic \n\t\t\tfor a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a\n\t\t\tspecified list of destination IP addresses and ports. Note that you cannot specify IP addresses \n\t\t\tor ports outside of the range that you configured for the endpoint group.
\nAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" } }, "com.amazonaws.globalaccelerator#DenyCustomRoutingTrafficRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
", "smithy.api#required": {} } }, "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
", "smithy.api#required": {} } }, "DestinationAddresses": { "target": "com.amazonaws.globalaccelerator#DestinationAddresses", "traits": { "smithy.api#documentation": "A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving \n\t\t\ttraffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the \n\t\t\tendpoint group.
" } }, "DestinationPorts": { "target": "com.amazonaws.globalaccelerator#DestinationPorts", "traits": { "smithy.api#documentation": "A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from \n\t\t\treceiving traffic.
" } }, "DenyAllTrafficToEndpoint": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot \n\t\t\treceive traffic from a custom routing accelerator. The value is TRUE or FALSE.
\nWhen set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\nWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive\n\t\t\ttraffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\nThe default value is FALSE.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidr": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DeprovisionByoipCidrRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DeprovisionByoipCidrResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ByoipCidrNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#IncorrectCidrStateException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Releases the specified address range that you provisioned to use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
\nBefore you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have \n\t\t\tany accelerators that are using static IP addresses allocated from its address range.\n\t\t
\nFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidrRequest": { "type": "structure", "members": { "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The address range, in CIDR notation. The prefix must be the same prefix that you specified \n\t\t\twhen you provisioned the address range.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidrResponse": { "type": "structure", "members": { "ByoipCidr": { "target": "com.amazonaws.globalaccelerator#ByoipCidr", "traits": { "smithy.api#documentation": "Information about the address range.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe an accelerator.
" } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributes": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributesRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributesResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe the attributes of an accelerator. \n\t\t
" } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributesRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributesResponse": { "type": "structure", "members": { "AcceleratorAttributes": { "target": "com.amazonaws.globalaccelerator#AcceleratorAttributes", "traits": { "smithy.api#documentation": "The attributes of the accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#Accelerator", "traits": { "smithy.api#documentation": "The description of the accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachment": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachmentRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#AttachmentNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Gets configuration information about a cross-account attachment.
" } }, "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachmentRequest": { "type": "structure", "members": { "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the cross-account attachment to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachmentResponse": { "type": "structure", "members": { "CrossAccountAttachment": { "target": "com.amazonaws.globalaccelerator#Attachment", "traits": { "smithy.api#documentation": "Information about the cross-account attachment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributes": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributesRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributesResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe the attributes of a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributesRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributesResponse": { "type": "structure", "members": { "AcceleratorAttributes": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAcceleratorAttributes", "traits": { "smithy.api#documentation": "The attributes of the custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAccelerator", "traits": { "smithy.api#documentation": "The description of the custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroupRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroupResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe an endpoint group for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroupRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroupResponse": { "type": "structure", "members": { "EndpointGroup": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroup", "traits": { "smithy.api#documentation": "The description of an endpoint group for a custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "The description of a listener for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingListenerResponse": { "type": "structure", "members": { "Listener": { "target": "com.amazonaws.globalaccelerator#CustomRoutingListener", "traits": { "smithy.api#documentation": "The description of a listener for a custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeEndpointGroupRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeEndpointGroupResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Describe an endpoint group.
" } }, "com.amazonaws.globalaccelerator#DescribeEndpointGroupRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeEndpointGroupResponse": { "type": "structure", "members": { "EndpointGroup": { "target": "com.amazonaws.globalaccelerator#EndpointGroup", "traits": { "smithy.api#documentation": "The description of an endpoint group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#DescribeListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#DescribeListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Describe a listener.
" } }, "com.amazonaws.globalaccelerator#DescribeListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeListenerResponse": { "type": "structure", "members": { "Listener": { "target": "com.amazonaws.globalaccelerator#Listener", "traits": { "smithy.api#documentation": "The description of a listener.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DestinationAddresses": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#IpAddress" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.globalaccelerator#DestinationPortMapping": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom routing accelerator \n\t\t\tthat you have port mappings for.
" } }, "AcceleratorSocketAddresses": { "target": "com.amazonaws.globalaccelerator#SocketAddresses", "traits": { "smithy.api#documentation": "The IP address/port combinations (sockets) that map to a given destination socket\n\t\t\taddress.
" } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } }, "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The ID for the virtual private cloud (VPC) subnet.
" } }, "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region for the endpoint group.
" } }, "DestinationSocketAddress": { "target": "com.amazonaws.globalaccelerator#SocketAddress", "traits": { "smithy.api#documentation": "The endpoint IP address/port combination for traffic received on the accelerator socket address.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "DestinationTrafficState": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationTrafficState", "traits": { "smithy.api#documentation": "Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if\n\t\t\ttraffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
" } } }, "traits": { "smithy.api#documentation": "The port mappings for a specified endpoint IP address (destination).
" } }, "com.amazonaws.globalaccelerator#DestinationPortMappings": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#DestinationPortMapping" } }, "com.amazonaws.globalaccelerator#DestinationPorts": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#PortNumber" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.globalaccelerator#EndpointAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The endpoint that you specified doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#EndpointConfiguration": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active \n\t\t\twhen you add it as an endpoint.
\nFor cross-account endpoints, this must be the ARN of the resource.
" } }, "Weight": { "target": "com.amazonaws.globalaccelerator#EndpointWeight", "traits": { "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the\n\t Global Accelerator Developer Guide.
" } }, "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for Application Load Balancer endpoints.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation\n\t\t\twith Network Load Balancers with TLS listeners.
\nFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources)\n\t\t\tthat can be added to accelerators and principals that have permission to add the endpoints.
" } } }, "traits": { "smithy.api#documentation": "A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
" } }, "com.amazonaws.globalaccelerator#EndpointConfigurations": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#EndpointConfiguration" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.globalaccelerator#EndpointDescription": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\nAn Application Load Balancer can be either internal or internet-facing.
" } }, "Weight": { "target": "com.amazonaws.globalaccelerator#EndpointWeight", "traits": { "smithy.api#documentation": "The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the\n\t Global Accelerator Developer Guide.
" } }, "HealthState": { "target": "com.amazonaws.globalaccelerator#HealthState", "traits": { "smithy.api#documentation": "The health status of the endpoint.
" } }, "HealthReason": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "Returns a null result.
" } }, "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for Application Load Balancers endpoints.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation\n\t\t\twith Network Load Balancers with TLS listeners.
\nFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load\n\t\t\tbalancers.
" } }, "com.amazonaws.globalaccelerator#EndpointDescriptions": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#EndpointDescription" } }, "com.amazonaws.globalaccelerator#EndpointGroup": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } }, "EndpointGroupRegion": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the endpoint group is located.
" } }, "EndpointDescriptions": { "target": "com.amazonaws.globalaccelerator#EndpointDescriptions", "traits": { "smithy.api#documentation": "The list of endpoint objects.
" } }, "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { "smithy.api#documentation": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
\nThe default port is the port for the listener that this endpoint group is associated with. If the listener port is a\n\t\t list, Global Accelerator uses the first specified port in the list of ports.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { "smithy.api#documentation": "The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" } }, "HealthCheckPath": { "target": "com.amazonaws.globalaccelerator#HealthCheckPath", "traits": { "smithy.api#documentation": "If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the\n\t\t\tendpoints for health checks. The default is slash (/).
" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "The time\u201410 seconds or 30 seconds\u2014between health checks for each endpoint. The default value is 30.
" } }, "ThresholdCount": { "target": "com.amazonaws.globalaccelerator#ThresholdCount", "traits": { "smithy.api#documentation": "The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.
" } }, "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { "smithy.api#documentation": "Allows you to override the destination ports used to route traffic to an endpoint. \n\t\t\tUsing a port override lets you map a list of external destination ports (that your\n\t\t\tusers send traffic to) to a list of internal destination ports that you want an application \n\t\t\tendpoint to receive traffic on.
" } } }, "traits": { "smithy.api#documentation": "A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.\n\t\t
" } }, "com.amazonaws.globalaccelerator#EndpointGroupAlreadyExistsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The endpoint group that you specified already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The endpoint group that you specified doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#EndpointGroups": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#EndpointGroup" } }, "com.amazonaws.globalaccelerator#EndpointIdentifier": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\nAn Application Load Balancer can be either internal or internet-facing.
", "smithy.api#required": {} } }, "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.
" } }, "com.amazonaws.globalaccelerator#EndpointIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#EndpointIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.globalaccelerator#EndpointIds": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#GenericString" } }, "com.amazonaws.globalaccelerator#EndpointNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The endpoint that you specified doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#EndpointWeight": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 255 } } }, "com.amazonaws.globalaccelerator#ErrorMessage": { "type": "string" }, "com.amazonaws.globalaccelerator#GenericBoolean": { "type": "boolean" }, "com.amazonaws.globalaccelerator#GenericString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.globalaccelerator#GlobalAccelerator_V20180706": { "type": "service", "version": "2018-08-08", "operations": [ { "target": "com.amazonaws.globalaccelerator#AddCustomRoutingEndpoints" }, { "target": "com.amazonaws.globalaccelerator#AddEndpoints" }, { "target": "com.amazonaws.globalaccelerator#AdvertiseByoipCidr" }, { "target": "com.amazonaws.globalaccelerator#AllowCustomRoutingTraffic" }, { "target": "com.amazonaws.globalaccelerator#CreateAccelerator" }, { "target": "com.amazonaws.globalaccelerator#CreateCrossAccountAttachment" }, { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingAccelerator" }, { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#CreateCustomRoutingListener" }, { "target": "com.amazonaws.globalaccelerator#CreateEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#CreateListener" }, { "target": "com.amazonaws.globalaccelerator#DeleteAccelerator" }, { "target": "com.amazonaws.globalaccelerator#DeleteCrossAccountAttachment" }, { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingAccelerator" }, { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#DeleteCustomRoutingListener" }, { "target": "com.amazonaws.globalaccelerator#DeleteEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#DeleteListener" }, { "target": "com.amazonaws.globalaccelerator#DenyCustomRoutingTraffic" }, { "target": "com.amazonaws.globalaccelerator#DeprovisionByoipCidr" }, { "target": "com.amazonaws.globalaccelerator#DescribeAccelerator" }, { "target": "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributes" }, { "target": "com.amazonaws.globalaccelerator#DescribeCrossAccountAttachment" }, { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAccelerator" }, { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributes" }, { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#DescribeCustomRoutingListener" }, { "target": "com.amazonaws.globalaccelerator#DescribeEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#DescribeListener" }, { "target": "com.amazonaws.globalaccelerator#ListAccelerators" }, { "target": "com.amazonaws.globalaccelerator#ListByoipCidrs" }, { "target": "com.amazonaws.globalaccelerator#ListCrossAccountAttachments" }, { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccounts" }, { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResources" }, { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingAccelerators" }, { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroups" }, { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingListeners" }, { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappings" }, { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestination" }, { "target": "com.amazonaws.globalaccelerator#ListEndpointGroups" }, { "target": "com.amazonaws.globalaccelerator#ListListeners" }, { "target": "com.amazonaws.globalaccelerator#ListTagsForResource" }, { "target": "com.amazonaws.globalaccelerator#ProvisionByoipCidr" }, { "target": "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpoints" }, { "target": "com.amazonaws.globalaccelerator#RemoveEndpoints" }, { "target": "com.amazonaws.globalaccelerator#TagResource" }, { "target": "com.amazonaws.globalaccelerator#UntagResource" }, { "target": "com.amazonaws.globalaccelerator#UpdateAccelerator" }, { "target": "com.amazonaws.globalaccelerator#UpdateAcceleratorAttributes" }, { "target": "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachment" }, { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAccelerator" }, { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributes" }, { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingListener" }, { "target": "com.amazonaws.globalaccelerator#UpdateEndpointGroup" }, { "target": "com.amazonaws.globalaccelerator#UpdateListener" }, { "target": "com.amazonaws.globalaccelerator#WithdrawByoipCidr" } ], "traits": { "aws.api#service": { "sdkId": "Global Accelerator", "arnNamespace": "globalaccelerator", "cloudFormationName": "GlobalAccelerator", "cloudTrailEventSource": "globalaccelerator.amazonaws.com", "docId": "globalaccelerator-2018-08-08", "endpointPrefix": "globalaccelerator" }, "aws.auth#sigv4": { "name": "globalaccelerator" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "This is the Global Accelerator API Reference. This guide is for developers who need detailed information about\n\t\t Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the \n\t \tGlobal Accelerator Developer Guide.
\nGlobal Accelerator is a service in which you create accelerators to improve the performance \n\t\t\tof your applications for local and global users. Depending on the type of accelerator you choose, you can\n\t\t\tgain additional benefits.
\nBy using a standard accelerator, you can improve availability of your internet applications \n\t\t\t that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services \n\t\t\t\tglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you \n\t\t\t\tcan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t \tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t \ton Amazon Web Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses \n\t\t\tare anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,\n\t\t\tGlobal Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. \n\t\t\tWith a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure \n\t\t\tthese entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP).
\nFor a standard accelerator, \n\t they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases \n\t\t\tthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, \n\t \tAmazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing\n\t accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\n\t\t\tare virtual private cloud (VPC) subnets.
\nThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\n\t\t\t\tdisable the accelerator and it no longer accepts or routes traffic. However, when you\n\t\t\t\t\tdelete an accelerator, you lose the static IP addresses that\n\t\t\t\tare assigned to it, so you can no longer route traffic by using them. You can use\n\t\t\t\tIAM policies like tag-based permissions with Global Accelerator to limit the users who have\n\t\t\t\tpermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based\n\t\t\ton health, client location, and policies that you configure. The service reacts instantly to\n\t\t\tchanges in health or configuration to ensure that internet traffic from clients is always\n\t\t\tdirected to healthy endpoints.
\nFor more information about understanding and using Global Accelerator, see the\n\t\t\tGlobal Accelerator Developer Guide.
", "smithy.api#title": "AWS Global Accelerator", "smithy.rules#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://globalaccelerator.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://globalaccelerator.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "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://globalaccelerator-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://globalaccelerator-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://globalaccelerator.{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://globalaccelerator.{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 us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://globalaccelerator-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://globalaccelerator-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://globalaccelerator.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://globalaccelerator.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://globalaccelerator-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://globalaccelerator-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://globalaccelerator.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://globalaccelerator.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://globalaccelerator-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://globalaccelerator-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://globalaccelerator.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://globalaccelerator.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 disabled", "expect": { "endpoint": { "url": "https://globalaccelerator-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 disabled", "expect": { "endpoint": { "url": "https://globalaccelerator.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 disabled", "expect": { "endpoint": { "url": "https://globalaccelerator-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 disabled", "expect": { "endpoint": { "url": "https://globalaccelerator.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.globalaccelerator#HealthCheckIntervalSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 10, "max": 30 } } }, "com.amazonaws.globalaccelerator#HealthCheckPath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^/[-a-zA-Z0-9@:%_\\\\+.~#?&/=]*$" } }, "com.amazonaws.globalaccelerator#HealthCheckPort": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.globalaccelerator#HealthCheckProtocol": { "type": "enum", "members": { "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP" } }, "HTTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP" } }, "HTTPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPS" } } } }, "com.amazonaws.globalaccelerator#HealthState": { "type": "enum", "members": { "INITIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INITIAL" } }, "HEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HEALTHY" } }, "UNHEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNHEALTHY" } } } }, "com.amazonaws.globalaccelerator#IdempotencyToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.globalaccelerator#IncorrectCidrStateException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be\n\t\tincorrect for this action.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#InternalServiceErrorException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "There was an internal error for Global Accelerator.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.globalaccelerator#InvalidArgumentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An argument that you specified is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "There isn't another item to return.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#InvalidPortRangeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The port numbers that you specified are not valid numbers or are not unique for this accelerator.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.globalaccelerator#IpAddress": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 45 } } }, "com.amazonaws.globalaccelerator#IpAddressDetail": { "type": "structure", "members": { "IpAddress": { "target": "com.amazonaws.globalaccelerator#IpAddress", "traits": { "smithy.api#documentation": "The static IP address.
" } }, "NetworkZone": { "target": "com.amazonaws.globalaccelerator#NetworkZone", "traits": { "smithy.api#documentation": "The network zone that the specified IP address is located on.
" } } }, "traits": { "smithy.api#documentation": "Detailed information for the IP addresses assigned to the Global Accelerator.
" } }, "com.amazonaws.globalaccelerator#IpAddressDetails": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#IpAddressDetail" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.globalaccelerator#IpAddressFamily": { "type": "enum", "members": { "IPv4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPv4" } }, "IPv6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPv6" } } } }, "com.amazonaws.globalaccelerator#IpAddressType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPV4" } }, "DUAL_STACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUAL_STACK" } } } }, "com.amazonaws.globalaccelerator#IpAddresses": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#IpAddress" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.globalaccelerator#IpSet": { "type": "structure", "members": { "IpFamily": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#deprecated": { "message": "IpFamily has been replaced by IpAddressFamily" }, "smithy.api#documentation": "IpFamily is deprecated and has been replaced by IpAddressFamily.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
" } }, "IpAddressFamily": { "target": "com.amazonaws.globalaccelerator#IpAddressFamily", "traits": { "smithy.api#documentation": "The types of IP addresses included in this IP set.
" } }, "IpAddressDetails": { "target": "com.amazonaws.globalaccelerator#IpAddressDetails", "traits": { "smithy.api#documentation": "The array of IP addresses in the IP address set, with detailed information about the IP addresses.\n\t\tAn IP address set can have a maximum of two IP addresses.
" } } }, "traits": { "smithy.api#documentation": "A complex type for the set of IP addresses for an accelerator.
" } }, "com.amazonaws.globalaccelerator#IpSets": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#IpSet" } }, "com.amazonaws.globalaccelerator#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Processing your request would cause you to exceed an Global Accelerator limit.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.globalaccelerator#ListAccelerators": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListAcceleratorsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListAcceleratorsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the accelerators for an Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Accelerators", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListAcceleratorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of Global Accelerator objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListAcceleratorsResponse": { "type": "structure", "members": { "Accelerators": { "target": "com.amazonaws.globalaccelerator#Accelerators", "traits": { "smithy.api#documentation": "The list of accelerators for a customer account.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListByoipCidrs": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListByoipCidrsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListByoipCidrsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including\n\t\t\tthe current state and a history of state changes.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ByoipCidrs", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListByoipCidrsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make\n\t\t\tanother call with the returned nextToken value.
The token for the next page of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListByoipCidrsResponse": { "type": "structure", "members": { "ByoipCidrs": { "target": "com.amazonaws.globalaccelerator#ByoipCidrs", "traits": { "smithy.api#documentation": "Information about your address ranges.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next page of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountAttachments": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountAttachmentsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountAttachmentsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the cross-account attachments that have been created in Global Accelerator.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "CrossAccountAttachments", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCrossAccountAttachmentsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of cross-account attachment objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountAttachmentsResponse": { "type": "structure", "members": { "CrossAccountAttachments": { "target": "com.amazonaws.globalaccelerator#Attachments", "traits": { "smithy.api#documentation": "Information about the cross-account attachments.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccounts": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccountsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccountsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" } ], "traits": { "smithy.api#documentation": "List the accounts that have cross-account resources.
\nFor more information, see \n\t\t\tWorking with cross-account attachments and resources in Global Accelerator in the \n\t\t\t\tGlobal Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccountsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountResourceAccountsResponse": { "type": "structure", "members": { "ResourceOwnerAwsAccountIds": { "target": "com.amazonaws.globalaccelerator#AwsAccountIds", "traits": { "smithy.api#documentation": "The account IDs of principals (resource owners) in a cross-account attachment who can work\n\t\t\twith resources listed in the same attachment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountResources": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResourcesRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCrossAccountResourcesResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the cross-account resources available to work with.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "CrossAccountResources", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCrossAccountResourcesRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
" } }, "ResourceOwnerAwsAccountId": { "target": "com.amazonaws.globalaccelerator#AwsAccountId", "traits": { "smithy.api#documentation": "The account ID of a resource owner in a cross-account attachment.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of cross-account resource objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCrossAccountResourcesResponse": { "type": "structure", "members": { "CrossAccountResources": { "target": "com.amazonaws.globalaccelerator#CrossAccountResources", "traits": { "smithy.api#documentation": "The cross-account resources used with an accelerator.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingAccelerators": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingAcceleratorsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingAcceleratorsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the custom routing accelerators for an Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Accelerators", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCustomRoutingAcceleratorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingAcceleratorsResponse": { "type": "structure", "members": { "Accelerators": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAccelerators", "traits": { "smithy.api#documentation": "The list of custom routing accelerators for a customer account.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroups": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroupsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroupsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "List the endpoint groups that are associated with a listener for a custom routing accelerator.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "EndpointGroups", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroupsRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of endpoint group objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroupsResponse": { "type": "structure", "members": { "EndpointGroups": { "target": "com.amazonaws.globalaccelerator#CustomRoutingEndpointGroups", "traits": { "smithy.api#documentation": "The list of the endpoint groups associated with a listener for a custom routing accelerator.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingListeners": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingListenersRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingListenersResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the listeners for a custom routing accelerator.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Listeners", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCustomRoutingListenersRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to list listeners for.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of listener objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingListenersResponse": { "type": "structure", "members": { "Listeners": { "target": "com.amazonaws.globalaccelerator#CustomRoutingListeners", "traits": { "smithy.api#documentation": "The list of listeners for a custom routing accelerator.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappings": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance\n\t\tIP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.\n\t\tFor each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port \n\t mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
\nIf you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to \n your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances\n in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
\nThe mappings also include a flag for each destination denoting which destination IP addresses and\n\t\tports are allowed or denied traffic.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "PortMappings", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestination": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestinationRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestinationResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#EndpointNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The\n\t\t\tresponse is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that \n\t\t\tspan multiple custom routing accelerators in your account, or for scenarios where you only want to\n\t\t\tlist the port mappings for a specific destination instance.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DestinationPortMappings", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestinationRequest": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The ID for the virtual private cloud (VPC) subnet.
", "smithy.api#required": {} } }, "DestinationAddress": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port\n\t\tmappings.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#PortMappingsMaxResults", "traits": { "smithy.api#documentation": "The number of destination port mappings that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestinationResponse": { "type": "structure", "members": { "DestinationPortMappings": { "target": "com.amazonaws.globalaccelerator#DestinationPortMappings", "traits": { "smithy.api#documentation": "The port mappings for the endpoint IP address that you specified in the request.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
", "smithy.api#required": {} } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
" } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#PortMappingsMaxResults", "traits": { "smithy.api#documentation": "The number of destination port mappings that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsResponse": { "type": "structure", "members": { "PortMappings": { "target": "com.amazonaws.globalaccelerator#PortMappings", "traits": { "smithy.api#documentation": "The port mappings for a custom routing accelerator.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListEndpointGroups": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListEndpointGroupsRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListEndpointGroupsResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "List the endpoint groups that are associated with a listener.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "EndpointGroups", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListEndpointGroupsRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of endpoint group objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListEndpointGroupsResponse": { "type": "structure", "members": { "EndpointGroups": { "target": "com.amazonaws.globalaccelerator#EndpointGroups", "traits": { "smithy.api#documentation": "The list of the endpoint groups associated with a listener.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListListeners": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListListenersRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListListenersResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "List the listeners for an accelerator.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Listeners", "pageSize": "MaxResults" } } }, "com.amazonaws.globalaccelerator#ListListenersRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.globalaccelerator#MaxResults", "traits": { "smithy.api#documentation": "The number of listener objects that you want to return with this call. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListListenersResponse": { "type": "structure", "members": { "Listeners": { "target": "com.amazonaws.globalaccelerator#Listeners", "traits": { "smithy.api#documentation": "The list of listeners for an accelerator.
" } }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AttachmentNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "List all tags for an accelerator.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.globalaccelerator#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { "smithy.api#documentation": "Root level tag for the Tags parameters.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#Listener": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
" } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The list of port ranges for the connections from clients to the accelerator.
" } }, "Protocol": { "target": "com.amazonaws.globalaccelerator#Protocol", "traits": { "smithy.api#documentation": "The protocol for the connections from clients to the accelerator.
" } }, "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties\u2014source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol\u2014to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties\u2014\n\t\t\tsource (client) IP address and destination IP address\u2014to select the hash value.
The default value is NONE.
A complex type for a listener.
" } }, "com.amazonaws.globalaccelerator#ListenerNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The listener that you specified doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.globalaccelerator#Listeners": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Listener" } }, "com.amazonaws.globalaccelerator#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.globalaccelerator#NetworkZone": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 24 } } }, "com.amazonaws.globalaccelerator#PortMapping": { "type": "structure", "members": { "AcceleratorPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The accelerator port.
" } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } }, "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The IP address of the VPC subnet (the subnet ID).
" } }, "DestinationSocketAddress": { "target": "com.amazonaws.globalaccelerator#SocketAddress", "traits": { "smithy.api#documentation": "The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
" } }, "Protocols": { "target": "com.amazonaws.globalaccelerator#CustomRoutingProtocols", "traits": { "smithy.api#documentation": "The protocols supported by the endpoint group.
" } }, "DestinationTrafficState": { "target": "com.amazonaws.globalaccelerator#CustomRoutingDestinationTrafficState", "traits": { "smithy.api#documentation": "Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if\n\t\t\ttraffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
" } } }, "traits": { "smithy.api#documentation": "Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual\n\t\t private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that\n\t\t statically associates port ranges with VPC subnets, which allows Global Accelerator to route to\n\t\t\tspecific instances and ports within one or more subnets.
" } }, "com.amazonaws.globalaccelerator#PortMappings": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#PortMapping" } }, "com.amazonaws.globalaccelerator#PortMappingsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20000 } } }, "com.amazonaws.globalaccelerator#PortNumber": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.globalaccelerator#PortOverride": { "type": "structure", "members": { "ListenerPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The listener port that you want to map to a specific endpoint port. This is the port that user traffic\n\t\t arrives to the Global Accelerator on.
" } }, "EndpointPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,\n\t\t such as the Application Load Balancer or Amazon EC2 instance.
" } } }, "traits": { "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t Overriding listener ports in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#PortOverrides": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#PortOverride" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.globalaccelerator#PortRange": { "type": "structure", "members": { "FromPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The first port in the range of ports, inclusive.
" } }, "ToPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The last port in the range of ports, inclusive.
" } } }, "traits": { "smithy.api#documentation": "A complex type for a range of ports for a listener.
" } }, "com.amazonaws.globalaccelerator#PortRanges": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#PortRange" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.globalaccelerator#Principal": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^(^\\d{12}$|arn:.*)$" } }, "com.amazonaws.globalaccelerator#Principals": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Principal" } }, "com.amazonaws.globalaccelerator#Protocol": { "type": "enum", "members": { "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP" } }, "UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UDP" } } } }, "com.amazonaws.globalaccelerator#Protocols": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Protocol" } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidr": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#ProvisionByoipCidrRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#ProvisionByoipCidrResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#IncorrectCidrStateException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP\n\t\t\taddresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, \n\t\t\tit is ready to be advertised using \n\t\t\tAdvertiseByoipCidr.
\nFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidrRequest": { "type": "structure", "members": { "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can\n\t\t\tspecify is /24. The address range cannot overlap with another address range that you've brought \n\t\t\tto this Amazon Web Services Region or another Region.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
", "smithy.api#required": {} } }, "CidrAuthorizationContext": { "target": "com.amazonaws.globalaccelerator#CidrAuthorizationContext", "traits": { "smithy.api#documentation": "A signed document that proves that you are authorized to bring the specified IP address range to\n\t\t\tAmazon using BYOIP.\n\t\t
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidrResponse": { "type": "structure", "members": { "ByoipCidr": { "target": "com.amazonaws.globalaccelerator#ByoipCidr", "traits": { "smithy.api#documentation": "Information about the address range.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpointsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ConflictException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#EndpointNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Remove endpoints from a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpointsRequest": { "type": "structure", "members": { "EndpointIds": { "target": "com.amazonaws.globalaccelerator#EndpointIds", "traits": { "smithy.api#documentation": "The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC)\n\t\tsubnet IDs.
", "smithy.api#required": {} } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#RemoveEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#RemoveEndpointsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Remove endpoints from an endpoint group.
\nThe RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove\n\t\t\tendpoints by updating an endpoint group by using the \n\t\t\tUpdateEndpointGroup\n\t\t\tAPI operation. There are two advantages to using AddEndpoints to remove endpoints instead:
It's more convenient, because you only need to specify the endpoints that you want to remove. With the \n\t\t\t\tUpdateEndpointGroup API operation, you must specify all of the endpoints in the \n\t\t\t\tendpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the \n\t\t\t\tUpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that\n\t\t\t\tremain in the group.
The identifiers of the endpoints that you want to remove.
", "smithy.api#required": {} } }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#Resource": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.
\nAn endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a \n\t\t\tNetwork Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
" } }, "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "An IP address range, in CIDR format, that is specified as resource. The address must\n\t\t\tbe provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process \n\t\t\tfor Global Accelerator
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
" } }, "Region": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where a shared endpoint resource is located.
" } } }, "traits": { "smithy.api#documentation": "A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by \n\t\t\tGlobal Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.
" } }, "com.amazonaws.globalaccelerator#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.globalaccelerator#Resources": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Resource" } }, "com.amazonaws.globalaccelerator#SocketAddress": { "type": "structure", "members": { "IpAddress": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The IP address for the socket address.
" } }, "Port": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { "smithy.api#documentation": "The port for the socket address.
" } } }, "traits": { "smithy.api#documentation": "An IP address/port combination.
" } }, "com.amazonaws.globalaccelerator#SocketAddresses": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#SocketAddress" } }, "com.amazonaws.globalaccelerator#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.globalaccelerator#TagKey", "traits": { "smithy.api#documentation": "A string that contains a Tag key.
A string that contains a Tag value.
A complex type that contains a Tag key and Tag value.
Add tags to an accelerator resource.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.globalaccelerator#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { "smithy.api#documentation": "The tags to add to a resource. A tag consists of a key and a value that you define.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.globalaccelerator#Tags": { "type": "list", "member": { "target": "com.amazonaws.globalaccelerator#Tag" } }, "com.amazonaws.globalaccelerator#ThresholdCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.globalaccelerator#Timestamp": { "type": "timestamp" }, "com.amazonaws.globalaccelerator#TrafficDialPercentage": { "type": "float", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.globalaccelerator#TransactionInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.globalaccelerator#ErrorMessage" } }, "traits": { "smithy.api#documentation": "There's already a transaction in progress. Another transaction can't be processed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.globalaccelerator#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UntagResourceRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.\n\t\t\tThe operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.globalaccelerator#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.globalaccelerator#TagKeys", "traits": { "smithy.api#documentation": "The tag key pairs that you want to remove from the specified resources.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ConflictException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Update an accelerator to make changes, such as the following:
\nChange the name of the accelerator.
\nDisable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.
\nEnable the accelerator, if it is disabled.
\nChange the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.
\nBe aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no \n\t\t\tlonger accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you \n\t\t\tcan no longer route traffic by using them.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton Amazon Web Services CLI commands.
Update the attributes for an accelerator.
" } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorAttributesRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator that you want to update.
", "smithy.api#required": {} } }, "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\t\tbucket.
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), \n\t\t\tlike the following:
\ns3-bucket_name//AWSLogs/aws_account_id
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorAttributesResponse": { "type": "structure", "members": { "AcceleratorAttributes": { "target": "com.amazonaws.globalaccelerator#AcceleratorAttributes", "traits": { "smithy.api#documentation": "Updated attributes for the accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "The IP addresses for an accelerator.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#Accelerator", "traits": { "smithy.api#documentation": "Information about the updated accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachment": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachmentRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#AttachmentNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Update a cross-account attachment to add or remove principals or resources. When you update \n\t\t\tan attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator \n\t\t\trevokes the permission for specific resources.
\nFor more information, see \n\t\t\tWorking with cross-account attachments and resources in Global Accelerator in the \n\t\t\t\tGlobal Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachmentRequest": { "type": "structure", "members": { "AttachmentArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cross-account attachment to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.globalaccelerator#AttachmentName", "traits": { "smithy.api#documentation": "The name of the cross-account attachment.
" } }, "AddPrincipals": { "target": "com.amazonaws.globalaccelerator#Principals", "traits": { "smithy.api#documentation": "The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN)\n\t\t\tof an accelerator that the attachment gives permission to work with resources from another account. The resources\n\t\t\tare also listed in the attachment.
\nTo add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
" } }, "RemovePrincipals": { "target": "com.amazonaws.globalaccelerator#Principals", "traits": { "smithy.api#documentation": "The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN)\n\t\t\tof an accelerator that the attachment gives permission to work with resources from another account. The resources\n\t\t\tare also listed in the attachment.
\nTo remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.
" } }, "AddResources": { "target": "com.amazonaws.globalaccelerator#Resources", "traits": { "smithy.api#documentation": "The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used\n\t\t\twith an accelerator by the principals that are listed in the attachment.
\nTo add more than one resource, separate the resource ARNs with commas.
" } }, "RemoveResources": { "target": "com.amazonaws.globalaccelerator#Resources", "traits": { "smithy.api#documentation": "The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used\n\t\t\twith an accelerator by the principals that are listed in the attachment.
\nTo remove more than one resource, separate the resource ARNs with commas.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCrossAccountAttachmentResponse": { "type": "structure", "members": { "CrossAccountAttachment": { "target": "com.amazonaws.globalaccelerator#Attachment", "traits": { "smithy.api#documentation": "Information about the updated cross-account attachment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAccelerator": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#ConflictException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Update a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributes": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributesRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributesResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AcceleratorNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#TransactionInProgressException" } ], "traits": { "smithy.api#documentation": "Update the attributes for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributesRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
", "smithy.api#required": {} } }, "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t true. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the\n\t\tbucket.
Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\nDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributesResponse": { "type": "structure", "members": { "AcceleratorAttributes": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAcceleratorAttributes", "traits": { "smithy.api#documentation": "Updated custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorRequest": { "type": "structure", "members": { "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the accelerator to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, \n\t\tperiods (.), or hyphens (-), and must not begin or end with a hyphen or period.
" } }, "IpAddressType": { "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "The IP addresses for an accelerator.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorResponse": { "type": "structure", "members": { "Accelerator": { "target": "com.amazonaws.globalaccelerator#CustomRoutingAccelerator", "traits": { "smithy.api#documentation": "Information about the updated custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateCustomRoutingListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidPortRangeException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Update a listener for a custom routing accelerator.
" } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to update.
", "smithy.api#required": {} } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The updated port range to support for connections from clients to your accelerator. If you remove ports that are\n\tcurrently being used by a subnet endpoint, the call fails.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingListenerResponse": { "type": "structure", "members": { "Listener": { "target": "com.amazonaws.globalaccelerator#CustomRoutingListener", "traits": { "smithy.api#documentation": "Information for the updated listener for a custom routing accelerator.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateEndpointGroup": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateEndpointGroupRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateEndpointGroupResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#EndpointGroupNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
" } }, "com.amazonaws.globalaccelerator#UpdateEndpointGroupRequest": { "type": "structure", "members": { "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
", "smithy.api#required": {} } }, "EndpointConfigurations": { "target": "com.amazonaws.globalaccelerator#EndpointConfigurations", "traits": { "smithy.api#documentation": "The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
" } }, "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { "smithy.api#documentation": "The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses\n\t\t\tthe first port in the list.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { "smithy.api#documentation": "The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.
" } }, "HealthCheckPath": { "target": "com.amazonaws.globalaccelerator#HealthCheckPath", "traits": { "smithy.api#documentation": "If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).
" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "The time\u201410 seconds or 30 seconds\u2014between each health check for an endpoint. The default value is 30.
" } }, "ThresholdCount": { "target": "com.amazonaws.globalaccelerator#ThresholdCount", "traits": { "smithy.api#documentation": "The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.
" } }, "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. \n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateEndpointGroupResponse": { "type": "structure", "members": { "EndpointGroup": { "target": "com.amazonaws.globalaccelerator#EndpointGroup", "traits": { "smithy.api#documentation": "The information about the endpoint group that was updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateListener": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#UpdateListenerRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#UpdateListenerResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" }, { "target": "com.amazonaws.globalaccelerator#InvalidPortRangeException" }, { "target": "com.amazonaws.globalaccelerator#LimitExceededException" }, { "target": "com.amazonaws.globalaccelerator#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "Update a listener.
" } }, "com.amazonaws.globalaccelerator#UpdateListenerRequest": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener to update.
", "smithy.api#required": {} } }, "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { "smithy.api#documentation": "The updated list of port ranges for the connections from clients to the accelerator.
" } }, "Protocol": { "target": "com.amazonaws.globalaccelerator#Protocol", "traits": { "smithy.api#documentation": "The updated protocol for the connections from clients to the accelerator.
" } }, "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties\u2014source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol\u2014to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties\u2014\n\t\t\tsource (client) IP address and destination IP address\u2014to select the hash value.
The default value is NONE.
Information for the updated listener.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidr": { "type": "operation", "input": { "target": "com.amazonaws.globalaccelerator#WithdrawByoipCidrRequest" }, "output": { "target": "com.amazonaws.globalaccelerator#WithdrawByoipCidrResponse" }, "errors": [ { "target": "com.amazonaws.globalaccelerator#AccessDeniedException" }, { "target": "com.amazonaws.globalaccelerator#ByoipCidrNotFoundException" }, { "target": "com.amazonaws.globalaccelerator#IncorrectCidrStateException" }, { "target": "com.amazonaws.globalaccelerator#InternalServiceErrorException" }, { "target": "com.amazonaws.globalaccelerator#InvalidArgumentException" } ], "traits": { "smithy.api#documentation": "Stops advertising an address range that is provisioned as an address pool.\n\t\t\tYou can perform this operation at most once every 10 seconds, even if you specify different address\n\t\t\tranges each time.
\nIt can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of\n\t\t\tpropagation delays.
\nFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidrRequest": { "type": "structure", "members": { "Cidr": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "The address range, in CIDR notation.
\nFor more information, see\n\t\t\tBring your own IP addresses (BYOIP) in \n\t\t\tthe Global Accelerator Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidrResponse": { "type": "structure", "members": { "ByoipCidr": { "target": "com.amazonaws.globalaccelerator#ByoipCidr", "traits": { "smithy.api#documentation": "Information about the BYOIP address pool.
" } } }, "traits": { "smithy.api#output": {} } } } }