{ "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.elasticloadbalancingv2#ALPNPolicyNotSupportedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ALPNPolicyNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified ALPN policy is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#Action": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.elasticloadbalancingv2#ActionTypeEnum", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of action.

", "smithy.api#required": {} } }, "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group. Specify only when Type is\n forward and you want to route to a single target group. To route to multiple\n target groups, you must use ForwardConfig instead.

" } }, "AuthenticateOidcConfig": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConfig", "traits": { "smithy.api#documentation": "

[HTTPS listeners] Information about an identity provider that is compliant with OpenID\n Connect (OIDC). Specify only when Type is authenticate-oidc.

" } }, "AuthenticateCognitoConfig": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig", "traits": { "smithy.api#documentation": "

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only\n when Type is authenticate-cognito.

" } }, "Order": { "target": "com.amazonaws.elasticloadbalancingv2#ActionOrder", "traits": { "smithy.api#documentation": "

The order for the action. This value is required for rules with multiple actions. The\n action with the lowest value for order is performed first.

" } }, "RedirectConfig": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig", "traits": { "smithy.api#documentation": "

[Application Load Balancer] Information for creating a redirect action. Specify only when\n Type is redirect.

" } }, "FixedResponseConfig": { "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig", "traits": { "smithy.api#documentation": "

[Application Load Balancer] Information for creating an action that returns a custom HTTP\n response. Specify only when Type is fixed-response.

" } }, "ForwardConfig": { "target": "com.amazonaws.elasticloadbalancingv2#ForwardActionConfig", "traits": { "smithy.api#documentation": "

Information for creating an action that distributes requests among multiple target\n groups. Specify only when Type is forward.

\n

If you specify both ForwardConfig and TargetGroupArn, you can \n specify only one target group using ForwardConfig and it must be the same \n target group specified in TargetGroupArn.

" } }, "JwtValidationConfig": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionConfig", "traits": { "smithy.api#documentation": "

[HTTPS listeners] Information for validating JWT access tokens in client requests.\n Specify only when Type is jwt-validation.

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

Information about an action.

\n

Each rule must include exactly one of the following routing actions: forward, \n fixed-response, or redirect, and it must be the last \n action to be performed.

\n

Optionally, a rule for an HTTPS listener can also include one of the following \n user authentication actions: authenticate-oidc,\n authenticate-cognito, or jwt-validation.

" } }, "com.amazonaws.elasticloadbalancingv2#ActionOrder": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50000 } } }, "com.amazonaws.elasticloadbalancingv2#ActionTypeEnum": { "type": "enum", "members": { "FORWARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "forward" } }, "AUTHENTICATE_OIDC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticate-oidc" } }, "AUTHENTICATE_COGNITO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticate-cognito" } }, "REDIRECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "redirect" } }, "FIXED_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fixed-response" } }, "JWT_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "jwt-validation" } } } }, "com.amazonaws.elasticloadbalancingv2#Actions": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Action" } }, "com.amazonaws.elasticloadbalancingv2#AddListenerCertificates": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#CertificateNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyCertificatesException" } ], "traits": { "smithy.api#documentation": "

Adds the specified SSL server certificate to the certificate list for the specified HTTPS\n or TLS listener.

\n

If the certificate in already in the certificate list, the call is successful but the\n certificate is not added again.

\n

For more information, see SSL\n certificates in the Application Load Balancers Guide or Server \n certificates in the Network Load Balancers Guide.

" } }, "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The certificate to add. You can specify one certificate per call. Set\n CertificateArn to the certificate ARN but do not set\n IsDefault.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesOutput": { "type": "structure", "members": { "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#documentation": "

Information about the certificates in the certificate list.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#AddTags": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#AddTagsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#AddTagsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateTagKeysException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your\n Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups,\n trust stores, listeners, and rules.

\n

Each tag consists of a key and an optional value. If a resource already has a tag with the\n same key, AddTags updates its value.

", "smithy.api#examples": [ { "title": "To add tags to a load balancer", "documentation": "This example adds the specified tags to the specified load balancer.", "input": { "ResourceArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "Tags": [ { "Key": "project", "Value": "lima" }, { "Key": "department", "Value": "digital-media" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#AddTagsInput": { "type": "structure", "members": { "ResourceArns": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The tags.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#AddTagsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocations": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocationsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocationsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidRevocationContentException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RevocationContentNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTrustStoreRevocationEntriesException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds the specified revocation file to the specified trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocationsInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "RevocationContents": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationContents", "traits": { "smithy.api#documentation": "

The revocation file to add.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocationsOutput": { "type": "structure", "members": { "TrustStoreRevocations": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreRevocations", "traits": { "smithy.api#documentation": "

Information about the revocation file added to the trust store.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#AdministrativeOverride": { "type": "structure", "members": { "State": { "target": "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideStateEnum", "traits": { "smithy.api#documentation": "

The state of the override.

" } }, "Reason": { "target": "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideReasonEnum", "traits": { "smithy.api#documentation": "

The reason code for the state.

" } }, "Description": { "target": "com.amazonaws.elasticloadbalancingv2#Description", "traits": { "smithy.api#documentation": "

A description of the override state that provides additional details.

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

Information about the override status applied to a target.

" } }, "com.amazonaws.elasticloadbalancingv2#AdvertiseTrustStoreCaNamesEnum": { "type": "enum", "members": { "on": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "on" } }, "off": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "off" } } } }, "com.amazonaws.elasticloadbalancingv2#AllocationId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AllocationIdNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AllocationIdNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified allocation ID does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyValue" } }, "com.amazonaws.elasticloadbalancingv2#AlpnPolicyValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AnomalyDetection": { "type": "structure", "members": { "Result": { "target": "com.amazonaws.elasticloadbalancingv2#AnomalyResultEnum", "traits": { "smithy.api#documentation": "

The latest anomaly detection result.

" } }, "MitigationInEffect": { "target": "com.amazonaws.elasticloadbalancingv2#MitigationInEffectEnum", "traits": { "smithy.api#documentation": "

Indicates whether anomaly mitigation is in progress.

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

Information about anomaly detection and mitigation.

" } }, "com.amazonaws.elasticloadbalancingv2#AnomalyResultEnum": { "type": "enum", "members": { "ANOMALOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "anomalous" } }, "NORMAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "normal" } } } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams": { "type": "map", "key": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestParamName" }, "value": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestParamValue" } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestParamName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestParamValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum": { "type": "enum", "members": { "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deny" } }, "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "allow" } }, "AUTHENTICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticate" } } } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig": { "type": "structure", "members": { "UserPoolArn": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

", "smithy.api#required": {} } }, "UserPoolClientId": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the Amazon Cognito user pool client.

", "smithy.api#required": {} } }, "UserPoolDomain": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolDomain", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

", "smithy.api#required": {} } }, "SessionCookieName": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionCookieName", "traits": { "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is\n AWSELBAuthSessionCookie.

" } }, "Scope": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope", "traits": { "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is\n openid.

\n

To verify which scope values your IdP supports and how to separate multiple values, see\n the documentation for your IdP.

" } }, "SessionTimeout": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionTimeout", "traits": { "smithy.api#documentation": "

The maximum duration of the authentication session, in seconds. The default is 604800\n seconds (7 days).

" } }, "AuthenticationRequestExtraParams": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams", "traits": { "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization\n endpoint.

" } }, "OnUnauthenticatedRequest": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum", "traits": { "smithy.api#documentation": "

The behavior if the user is not authenticated. The following are possible values:

\n " } } }, "traits": { "smithy.api#documentation": "

Request parameters to use when integrating with Amazon Cognito to authenticate\n users.

" } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionCookieName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionTimeout": { "type": "long" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolDomain": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestExtraParams": { "type": "map", "key": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestParamName" }, "value": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestParamValue" } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestParamName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestParamValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthorizationEndpoint": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientSecret": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConditionalBehaviorEnum": { "type": "enum", "members": { "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deny" } }, "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "allow" } }, "AUTHENTICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticate" } } } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConfig": { "type": "structure", "members": { "Issuer": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionIssuer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS\n protocol, the domain, and the path.

", "smithy.api#required": {} } }, "AuthorizationEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthorizationEndpoint", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS\n protocol, the domain, and the path.

", "smithy.api#required": {} } }, "TokenEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionTokenEndpoint", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the\n domain, and the path.

", "smithy.api#required": {} } }, "UserInfoEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUserInfoEndpoint", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol,\n the domain, and the path.

", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The OAuth 2.0 client identifier.

", "smithy.api#required": {} } }, "ClientSecret": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientSecret", "traits": { "smithy.api#documentation": "

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you\n are modifying a rule, you can omit this parameter if you set\n UseExistingClientSecret to true.

" } }, "SessionCookieName": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName", "traits": { "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is\n AWSELBAuthSessionCookie.

" } }, "Scope": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionScope", "traits": { "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is\n openid.

\n

To verify which scope values your IdP supports and how to separate multiple values, see\n the documentation for your IdP.

" } }, "SessionTimeout": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionTimeout", "traits": { "smithy.api#documentation": "

The maximum duration of the authentication session, in seconds. The default is 604800\n seconds (7 days).

" } }, "AuthenticationRequestExtraParams": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestExtraParams", "traits": { "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization\n endpoint.

" } }, "OnUnauthenticatedRequest": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConditionalBehaviorEnum", "traits": { "smithy.api#documentation": "

The behavior if the user is not authenticated. The following are possible values:

\n " } }, "UseExistingClientSecret": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUseExistingClientSecret", "traits": { "smithy.api#documentation": "

Indicates whether to use the existing client secret when modifying a rule. If you are\n creating a rule, you can omit this parameter or set it to false.

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

Request parameters when using an identity provider (IdP) that is compliant with OpenID\n Connect (OIDC) to authenticate users.

" } }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionIssuer": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionScope": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionTimeout": { "type": "long" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionTokenEndpoint": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUseExistingClientSecret": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUserInfoEndpoint": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#AvailabilityZone": { "type": "structure", "members": { "ZoneName": { "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", "traits": { "smithy.api#documentation": "

The name of the Availability Zone.

" } }, "SubnetId": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", "traits": { "smithy.api#documentation": "

The ID of the subnet. You can specify one subnet per Availability Zone.

" } }, "OutpostId": { "target": "com.amazonaws.elasticloadbalancingv2#OutpostId", "traits": { "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the Outpost.

" } }, "LoadBalancerAddresses": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses", "traits": { "smithy.api#documentation": "

[Network Load Balancers] If you need static IP addresses for your load balancer, you can\n specify one Elastic IP address per Availability Zone when you create an internal-facing load\n balancer. For internal load balancers, you can specify a private IP address from the IPv4\n range of the subnet.

" } }, "SourceNatIpv6Prefixes": { "target": "com.amazonaws.elasticloadbalancingv2#SourceNatIpv6Prefixes", "traits": { "smithy.api#documentation": "

[Network Load Balancers with UDP listeners] The IPv6 prefixes to use for source NAT.\n For each subnet, specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or\n auto_assigned to use an IPv6 prefix selected at random from the subnet CIDR\n block.

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

Information about an Availability Zone.

" } }, "com.amazonaws.elasticloadbalancingv2#AvailabilityZoneNotSupportedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AvailabilityZoneNotSupported", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified Availability Zone is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#AvailabilityZones": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZone" } }, "com.amazonaws.elasticloadbalancingv2#CaCertificatesBundleNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CaCertificatesBundleNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified ca certificate bundle does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#CanonicalHostedZoneId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#CapacityDecreaseRequestsLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CapacityDecreaseRequestLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've exceeded the daily capacity decrease limit for this reservation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#CapacityReservationPendingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CapacityReservationPending", "httpResponseCode": 400 }, "smithy.api#documentation": "

There is a pending capacity reservation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#CapacityReservationStateEnum": { "type": "enum", "members": { "PROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "provisioned" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "REBALANCING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "rebalancing" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failed" } } } }, "com.amazonaws.elasticloadbalancingv2#CapacityReservationStatus": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.elasticloadbalancingv2#CapacityReservationStateEnum", "traits": { "smithy.api#documentation": "

The status code.

" } }, "Reason": { "target": "com.amazonaws.elasticloadbalancingv2#StateReason", "traits": { "smithy.api#documentation": "

The reason code for the status.

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

The status of a capacity reservation.

" } }, "com.amazonaws.elasticloadbalancingv2#CapacityUnits": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#CapacityUnitsDouble": { "type": "double" }, "com.amazonaws.elasticloadbalancingv2#CapacityUnitsLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CapacityUnitsLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've exceeded the capacity units limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#Certificate": { "type": "structure", "members": { "CertificateArn": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, "IsDefault": { "target": "com.amazonaws.elasticloadbalancingv2#Default", "traits": { "smithy.api#documentation": "

Indicates whether the certificate is the default certificate. Do not set this value when\n specifying a certificate as an input. This value is not included in the output when describing\n a listener, but is included when describing listener certificates.

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

Information about an SSL server certificate.

" } }, "com.amazonaws.elasticloadbalancingv2#CertificateArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#CertificateList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Certificate" } }, "com.amazonaws.elasticloadbalancingv2#CertificateNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "CertificateNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified certificate does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#Cipher": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#CipherName", "traits": { "smithy.api#documentation": "

The name of the cipher.

" } }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#CipherPriority", "traits": { "smithy.api#documentation": "

The priority of the cipher.

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

Information about a cipher used in a policy.

" } }, "com.amazonaws.elasticloadbalancingv2#CipherName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#CipherPriority": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#Ciphers": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Cipher" } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilter": { "type": "structure", "members": { "Field": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterField", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The client certificate field to match. The possible values are:

\n \n

If the client certificate doesn't contain the field, the filter doesn't match. If the\n field has multiple values, the filter matches if it matches any one of the values.

", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterAction", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The action to take when the client certificate matches the filter. The only supported\n action is accept.

", "smithy.api#required": {} } }, "MatchType": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterMatchType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The match type. The possible values are exact and\n prefix.

\n

For the subject-cn, subject-ou, and san-dns\n fields, matching is case-insensitive. For the san-uri field, the scheme and host\n are matched case-insensitively, and the rest of the URI is matched case-sensitively.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The value to match. The value must be 1\u2013256 printable ASCII characters.

\n

If the field is san-uri, the value must begin with a letter. Before the\n first colon, the value can contain only letters, digits, plus signs (+), hyphens (-), or\n periods (.). If the match type is exact, the value must contain a colon. For\n example, spiffe://example.com/workload is a valid value.

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

Describes a client certificate identity filter.

" } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterAction": { "type": "enum", "members": { "ACCEPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "accept" } } } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterField": { "type": "enum", "members": { "SUBJECT_CN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "subject-cn" } }, "SUBJECT_OU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "subject-ou" } }, "SAN_DNS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "san-dns" } }, "SAN_URI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "san-uri" } } } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterMatchType": { "type": "enum", "members": { "EXACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "exact" } }, "PREFIX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "prefix" } } } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilters": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.elasticloadbalancingv2#ConditionFieldName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "com.amazonaws.elasticloadbalancingv2#CreateListener": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#CreateListenerInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#CreateListenerOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ALPNPolicyNotSupportedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#CertificateNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateListenerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#IncompatibleProtocolsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidLoadBalancerActionException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#SSLPolicyNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAssociationLimitException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyActionsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyCertificatesException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyListenersException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyUniqueTargetGroupsPerLoadBalancerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotReadyException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or\n Gateway Load Balancer.

\n

For more information, see the following:

\n \n

This operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple listeners with the same settings, each call succeeds.

", "smithy.api#examples": [ { "title": "To create an HTTP listener", "documentation": "This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Protocol": "HTTP", "Port": 80, "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } ] }, "output": { "Listeners": [ { "Protocol": "HTTP", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Port": 80, "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } }, { "title": "To create an HTTPS listener", "documentation": "This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Protocol": "HTTPS", "Port": 443, "SslPolicy": "ELBSecurityPolicy-2015-05", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" } ], "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } ] }, "output": { "Listeners": [ { "Protocol": "HTTPS", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "SslPolicy": "ELBSecurityPolicy-2015-05", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Port": 443, "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#CreateListenerInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol for connections from clients to the load balancer. For Application Load\n Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\n supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC. You can\u2019t specify the UDP, TCP_UDP, QUIC, or TCP_QUIC\n protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load\n Balancer.

" } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port on which the load balancer is listening. You can't specify a port for a Gateway\n Load Balancer.

" } }, "SslPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported.

\n

For more information, see Security policies in the Application Load Balancers Guide and\n Security policies in the Network Load Balancers Guide.

" } }, "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide\n exactly one certificate. Set CertificateArn to the certificate ARN but do not set\n IsDefault.

" } }, "DefaultActions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The actions for the default rule.

", "smithy.api#required": {} } }, "AlpnPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { "smithy.api#documentation": "

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You\n can specify one policy name. The following are the possible values:

\n \n

For more information, see ALPN\n policies in the Network Load Balancers Guide.

" } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

The tags to assign to the listener.

" } }, "MutualAuthentication": { "target": "com.amazonaws.elasticloadbalancingv2#MutualAuthenticationAttributes", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The mutual authentication configuration information.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateListenerOutput": { "type": "structure", "members": { "Listeners": { "target": "com.amazonaws.elasticloadbalancingv2#Listeners", "traits": { "smithy.api#documentation": "

Information about the listener.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#AllocationIdNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZoneNotSupportedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateLoadBalancerNameException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateTagKeysException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSchemeException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSecurityGroupException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSubnetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ResourceInUseException" }, { "target": "com.amazonaws.elasticloadbalancingv2#SubnetNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyLoadBalancersException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer.

\n

For more information, see the following:

\n \n

This operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple load balancers with the same settings, each call succeeds.

", "smithy.api#examples": [ { "title": "To create an Internet-facing load balancer", "documentation": "This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.", "input": { "Name": "my-load-balancer", "Subnets": [ "subnet-b7d581c0", "subnet-8360a9e7" ] }, "output": { "LoadBalancers": [ { "VpcId": "vpc-3ac0fb5f", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "State": { "Code": "provisioning" }, "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-load-balancer", "CreatedTime": "2016-03-25T21:26:12.920Z", "Scheme": "internet-facing", "Type": "application", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } ] } }, { "title": "To create an internal load balancer", "documentation": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", "input": { "Name": "my-internal-load-balancer", "Subnets": [ "subnet-b7d581c0", "subnet-8360a9e7" ], "SecurityGroups": [], "Scheme": "internal" }, "output": { "LoadBalancers": [ { "VpcId": "vpc-3ac0fb5f", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", "State": { "Code": "provisioning" }, "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-internal-load-balancer", "CreatedTime": "2016-03-25T21:29:48.850Z", "Scheme": "internal", "Type": "application", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the load balancer.

\n

This name must be unique per region per account, can have a maximum of 32 characters, must\n contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must\n not begin with \"internal-\".

", "smithy.api#required": {} } }, "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { "smithy.api#documentation": "

The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more \n Availability Zones.

" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { "smithy.api#documentation": "

The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You can't specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n can't specify Elastic IP addresses for your subnets.

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

[Application Load Balancers and Network Load Balancers] The IDs of the security groups for\n the load balancer.

" } }, "Scheme": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", "traits": { "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an\n Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes.\n Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of an\n internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

\n

The default is an Internet-facing load balancer.

\n

You can't specify a scheme for a Gateway Load Balancer.

" } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

The tags to assign to the load balancer.

" } }, "Type": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", "traits": { "smithy.api#documentation": "

The type of load balancer. The default is application.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type. Internal load balancers must use ipv4.

\n

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), \n dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 \n (public IPv6 addresses and private IPv4 and IPv6 addresses).

\n

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 \n (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

" } }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", "traits": { "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP\n pool).

" } }, "EnablePrefixForIpv6SourceNat": { "target": "com.amazonaws.elasticloadbalancingv2#EnablePrefixForIpv6SourceNatEnum", "traits": { "smithy.api#documentation": "

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix \n from each subnet for source NAT. The IP address type must be dualstack. \n The default value is off.

" } }, "IpamPools": { "target": "com.amazonaws.elasticloadbalancingv2#IpamPools", "traits": { "smithy.api#documentation": "

[Application Load Balancers] The IPAM pools to use with the load balancer.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerOutput": { "type": "structure", "members": { "LoadBalancers": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancers", "traits": { "smithy.api#documentation": "

Information about the load balancer.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateRule": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#CreateRuleInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#CreateRuleOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#IncompatibleProtocolsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidLoadBalancerActionException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#PriorityInUseException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAssociationLimitException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyActionsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRulesException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetGroupsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyUniqueTargetGroupsPerLoadBalancerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Creates a rule for the specified listener. The listener must be associated with an\n Application Load Balancer or a dual-stack Network Load Balancer.

\n

Each rule consists of a priority, one or more actions, and one or more conditions. Rules\n are evaluated in priority order, from the lowest value to the highest value. When the\n conditions for a rule are met, its actions are performed. If the conditions for no rules are\n met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide or\n Listener rules in the Network Load Balancers Guide.

", "smithy.api#examples": [ { "title": "To create a rule", "documentation": "This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", "Conditions": [ { "Field": "path-pattern", "Values": [ "/img/*" ] } ], "Priority": 10, "Actions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } ] }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "path-pattern", "Values": [ "/img/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } }, { "title": "To create a listener rule that routes IPv4 traffic on a Network Load Balancer", "documentation": "This example creates a rule on a dual-stack Network Load Balancer that routes IPv4 source traffic to an IPv4 target group.", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/net/my-nlb/1234567890abcdef/1234567890abcdef", "Conditions": [ { "Field": "source-ip", "SourceIpConfig": { "IpAddressType": "ipv4" } } ], "Priority": 10, "Actions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef" } ] }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "source-ip", "SourceIpConfig": { "IpAddressType": "ipv4" } } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", "Type": "forward" } ] } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#CreateRuleInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, "Conditions": { "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The conditions.

", "smithy.api#required": {} } }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The rule priority. A listener can't have multiple rules with the same priority.

", "smithy.api#required": {} } }, "Actions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The actions.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

The tags to assign to the rule.

" } }, "Transforms": { "target": "com.amazonaws.elasticloadbalancingv2#RuleTransformList", "traits": { "smithy.api#documentation": "

The transforms to apply to requests that match this rule. You can add one host header rewrite transform \n and one URL rewrite transform.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateRuleOutput": { "type": "structure", "members": { "Rules": { "target": "com.amazonaws.elasticloadbalancingv2#Rules", "traits": { "smithy.api#documentation": "

Information about the rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateTargetGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateTargetGroupNameException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetGroupsException" } ], "traits": { "smithy.api#documentation": "

Creates a target group.

\n

For more information, see the following:

\n \n

This operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple target groups with the same settings, each call succeeds.

", "smithy.api#examples": [ { "title": "To create a target group", "documentation": "This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.", "input": { "Name": "my-targets", "Protocol": "HTTP", "Port": 80, "VpcId": "vpc-3ac0fb5f" }, "output": { "TargetGroups": [ { "HealthCheckPath": "/", "HealthCheckIntervalSeconds": 30, "VpcId": "vpc-3ac0fb5f", "Protocol": "HTTP", "HealthCheckTimeoutSeconds": 5, "HealthCheckProtocol": "HTTP", "UnhealthyThresholdCount": 2, "HealthyThresholdCount": 5, "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Matcher": { "HttpCode": "200" }, "HealthCheckPort": "traffic-port", "Port": 80, "TargetGroupName": "my-targets" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the target group.

\n

This name must be unique per region per account, can have a maximum of 32 characters, must\n contain only alphanumeric characters or hyphens, and must not begin or end with a\n hyphen.

", "smithy.api#required": {} } }, "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. For Application Load Balancers,\n the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported\n protocols are TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is\n GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a\n Lambda function, this parameter does not apply.

" } }, "ProtocolVersion": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolVersion", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to\n targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The\n default is HTTP1, which sends requests to targets using HTTP/1.1.

" } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port on which the targets receive traffic. This port is used unless you specify a port\n override when registering the target. If the target is a Lambda function, this parameter does\n not apply. If the protocol is GENEVE, the supported port is 6081.

" } }, "VpcId": { "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the virtual private cloud (VPC). If the target is a Lambda function,\n this parameter does not apply. Otherwise, this parameter is required.

" } }, "HealthCheckProtocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets. For\n Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load\n Balancers, the default is TCP. The TCP protocol is not supported for health checks if the\n protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are\n not supported for health checks.

" } }, "HealthCheckPort": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets. If the protocol\n is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC the default is traffic-port, which is\n the port on which each target receives traffic from the load balancer. If the protocol is\n GENEVE, the default is port 80.

" } }, "HealthCheckEnabled": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { "smithy.api#documentation": "

Indicates whether health checks are enabled. If the target type is lambda,\n health checks are disabled by default but can be enabled. If the target type is\n instance, ip, or alb, health checks are always\n enabled and can't be disabled.

" } }, "HealthCheckPath": { "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS health checks] The destination for health checks on the targets.

\n

[HTTP1 or HTTP2 protocol version] The ping path. The default is /.

\n

[GRPC protocol version] The path of a custom health check method with the format\n /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300.\n If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 30 seconds. \n If the target group protocol is GENEVE, the default is 10 seconds. \n If the target type is lambda, the default is 35 seconds.

" } }, "HealthCheckTimeoutSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, during which no response from a target means a failed \n health check. The range is 2\u2013120 seconds. For target groups with a protocol of HTTP, the \n default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default \n is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If \n the target type is lambda, the default is 30 seconds.

" } }, "HealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health check successes required before considering a target healthy. The range is \n 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups \n with a protocol of GENEVE, the default is 5. If the target type \n is lambda, the default is 5.

" } }, "UnhealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health check failures required before considering a target unhealthy. The range is \n 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 2. For target groups \n with a protocol of GENEVE, the default is 2. If the target type \n is lambda, the default is 5.

" } }, "Matcher": { "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful \n response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range \n is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target \n groups with a protocol of GENEVE, the range is 200-399.

" } }, "TargetType": { "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", "traits": { "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target group.\n You can't specify targets for a target group using more than one target type.

\n " } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

The tags to assign to the target group.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupIpAddressTypeEnum", "traits": { "smithy.api#documentation": "

The IP address type. The default value is ipv4.

" } }, "TargetControlPort": { "target": "com.amazonaws.elasticloadbalancingv2#TargetControlPort", "traits": { "smithy.api#documentation": "

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupOutput": { "type": "structure", "members": { "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroups", "traits": { "smithy.api#documentation": "

Information about the target group.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateTrustStore": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#CreateTrustStoreInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#CreateTrustStoreOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#CaCertificatesBundleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateTagKeysException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateTrustStoreNameException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidCaCertificatesBundleException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTrustStoresException" } ], "traits": { "smithy.api#documentation": "

Creates a trust store.

\n

For more information, see Mutual TLS for Application Load Balancers\n or Mutual TLS for Network Load Balancers.

" } }, "com.amazonaws.elasticloadbalancingv2#CreateTrustStoreInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the trust store.

\n

This name must be unique per region and can't be changed after creation.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3Bucket": { "target": "com.amazonaws.elasticloadbalancingv2#S3Bucket", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 bucket for the ca certificates bundle.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3Key": { "target": "com.amazonaws.elasticloadbalancingv2#S3Key", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 path for the ca certificates bundle.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3ObjectVersion": { "target": "com.amazonaws.elasticloadbalancingv2#S3ObjectVersion", "traits": { "smithy.api#documentation": "

The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

" } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

The tags to assign to the trust store.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#CreateTrustStoreOutput": { "type": "structure", "members": { "TrustStores": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStores", "traits": { "smithy.api#documentation": "

Information about the trust store created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#CreatedTime": { "type": "timestamp" }, "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^(ipv4pool-coip-)[a-zA-Z0-9]+$" } }, "com.amazonaws.elasticloadbalancingv2#DNSName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#DecreaseRequestsRemaining": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#Default": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#DeleteAssociationSameAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DeleteAssociationSameAccount", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified association can't be within the same account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#DeleteListener": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteListenerInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteListenerOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ResourceInUseException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified listener.

\n

Alternatively, your listener is deleted when you delete the load balancer to which it is\n attached.

", "smithy.api#examples": [ { "title": "To delete a listener", "documentation": "This example deletes the specified listener.", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeleteListenerInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteListenerOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancerInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancerOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ResourceInUseException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer. Deleting a load balancer also deletes its listeners.

\n

You can't delete a load balancer if deletion protection is enabled. If the load balancer\n does not exist or has already been deleted, the call succeeds.

\n

Deleting a load balancer does not affect its registered targets. For example, your EC2\n instances continue to run and are still registered to their target groups. If you no longer\n need these EC2 instances, you can stop or terminate them.

", "smithy.api#examples": [ { "title": "To delete a load balancer", "documentation": "This example deletes the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancerInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancerOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteRule": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteRuleInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteRuleOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified rule.

\n

You can't delete the default rule.

", "smithy.api#examples": [ { "title": "To delete a rule", "documentation": "This example deletes the specified rule.", "input": { "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeleteRuleInput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteRuleOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociation": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociationInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociationOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#DeleteAssociationSameAccountException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a shared trust store association.

", "smithy.api#examples": [ { "title": "Delete a shared trust store association", "documentation": "This example deletes the association between the specified trust store and the specified load balancer.", "input": { "TrustStoreArn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:truststore/my-trust-store/73e2d6bc24d8a063", "ResourceArn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-load-balancer/80233fa81d678c2c" } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociationInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroupInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroupOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ResourceInUseException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified target group.

\n

You can delete a target group if it is not referenced by any actions. Deleting a target\n group also deletes any associated health checks. Deleting a target group does not affect its\n registered targets. For example, any EC2 instances continue to run until you stop or terminate\n them.

", "smithy.api#examples": [ { "title": "To delete a target group", "documentation": "This example deletes the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroupInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroupOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteTrustStore": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTrustStoreInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTrustStoreOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreInUseException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#DeleteTrustStoreInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeleteTrustStoreOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DeregisterTargets": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidTargetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deregisters the specified targets from the specified target group. After the targets are\n deregistered, they no longer receive traffic from the load balancer.

\n

The load balancer stops sending requests to targets that are deregistering, but uses \n connection draining to ensure that in-flight traffic completes on the existing connections. \n This deregistration delay is configured by default but can be updated for each target group.

\n

For more information, see the following:

\n \n

Note: If the specified target does not exist, the action returns successfully.

", "smithy.api#examples": [ { "title": "To deregister a target from a target group", "documentation": "This example deregisters the specified instance from the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Targets": [ { "Id": "i-0f76fade" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, "Targets": { "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The targets. If you specified a port override when you registered a target, you must\n specify both the target ID and the port when you deregister it.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimits": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsOutput" }, "traits": { "smithy.api#documentation": "

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services\n account.

\n

For more information, see the following:

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "Limits" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsInput": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsOutput": { "type": "structure", "members": { "Limits": { "target": "com.amazonaws.elasticloadbalancingv2#Limits", "traits": { "smithy.api#documentation": "

Information about the limits.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservation": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservationInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservationOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the capacity reservation status for the specified load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservationInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservationOutput": { "type": "structure", "members": { "LastModifiedTime": { "target": "com.amazonaws.elasticloadbalancingv2#LastModifiedTime", "traits": { "smithy.api#documentation": "

The last time the capacity reservation was modified.

" } }, "DecreaseRequestsRemaining": { "target": "com.amazonaws.elasticloadbalancingv2#DecreaseRequestsRemaining", "traits": { "smithy.api#documentation": "

The amount of daily capacity decreases remaining.

" } }, "MinimumLoadBalancerCapacity": { "target": "com.amazonaws.elasticloadbalancingv2#MinimumLoadBalancerCapacity", "traits": { "smithy.api#documentation": "

The requested minimum capacity reservation for the load balancer

" } }, "CapacityReservationState": { "target": "com.amazonaws.elasticloadbalancingv2#ZonalCapacityReservationStates", "traits": { "smithy.api#documentation": "

The state of the capacity reservation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the attributes for the specified listener.

", "smithy.api#examples": [ { "title": "Describe listener attributes", "documentation": "This example describes the attributes of the specified listener.", "input": { "ListenerArn": "aws:elasticloadbalancing:us-east-1:123456789012:listener/net/my-listener/73e2d6bc24d8a067/d5dc06411fa5bcea" }, "output": {} } ] } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttributes", "traits": { "smithy.api#documentation": "

Information about the listener attributes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificates": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the default certificate and the certificate list for the specified HTTPS or TLS\n listener.

\n

If the default certificate is also in the certificate list, it appears twice in the\n results (once with IsDefault set to true and once with IsDefault set\n to false).

\n

For more information, see SSL certificates in the Application Load Balancers Guide or\n Server certificates in the Network Load Balancers\n Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "Certificates" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listener.

", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesOutput": { "type": "structure", "members": { "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#documentation": "

Information about the certificates.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListeners": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenersInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenersOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Describes the specified listeners or the listeners for the specified Application Load\n Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load\n balancer or one or more listeners.

", "smithy.api#examples": [ { "title": "To describe a listener", "documentation": "This example describes the specified listener.", "input": { "ListenerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" ] }, "output": { "Listeners": [ { "Protocol": "HTTP", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Port": 80, "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "Listeners" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenersInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "ListenerArns": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listeners.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenersOutput": { "type": "structure", "members": { "Listeners": { "target": "com.amazonaws.elasticloadbalancingv2#Listeners", "traits": { "smithy.api#documentation": "

Information about the listeners.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the attributes for the specified Application Load Balancer, Network Load\n Balancer, or Gateway Load Balancer.

\n

For more information, see the following:

\n ", "smithy.api#examples": [ { "title": "To describe load balancer attributes", "documentation": "This example describes the attributes of the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" }, "output": { "Attributes": [ { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "false", "Key": "deletion_protection.enabled" }, { "Value": "", "Key": "access_logs.s3.bucket" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributesInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes", "traits": { "smithy.api#documentation": "

Information about the load balancer attributes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancers": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the specified load balancers or all of your load balancers.

", "smithy.api#examples": [ { "title": "To describe a load balancer", "documentation": "This example describes the specified load balancer.", "input": { "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ] }, "output": { "LoadBalancers": [ { "VpcId": "vpc-3ac0fb5f", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "State": { "Code": "active" }, "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", "SecurityGroups": [ "sg-5943793c" ], "LoadBalancerName": "my-load-balancer", "CreatedTime": "2016-03-25T21:26:12.920Z", "Scheme": "internet-facing", "Type": "application", "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "LoadBalancers" }, "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.test#smokeTests": [ { "id": "DescribeLoadBalancersSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } }, { "id": "DescribeLoadBalancersFailure", "params": { "LoadBalancerArns": [ "fake_load_balancer" ] }, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "failure": {} } } ], "smithy.waiters#waitable": { "LoadBalancerAvailable": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "LoadBalancers[].State.Code", "expected": "active", "comparator": "allStringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "LoadBalancers[].State.Code", "expected": "provisioning", "comparator": "anyStringEquals" } } }, { "state": "retry", "matcher": { "errorType": "LoadBalancerNotFound" } } ], "minDelay": 15 }, "LoadBalancerExists": { "acceptors": [ { "state": "success", "matcher": { "success": true } }, { "state": "retry", "matcher": { "errorType": "LoadBalancerNotFound" } } ], "minDelay": 15 }, "LoadBalancersDeleted": { "acceptors": [ { "state": "retry", "matcher": { "output": { "path": "LoadBalancers[].State.Code", "expected": "active", "comparator": "allStringEquals" } } }, { "state": "success", "matcher": { "errorType": "LoadBalancerNotFound" } } ], "minDelay": 15 } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersInput": { "type": "structure", "members": { "LoadBalancerArns": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load\n balancers in a single call.

" } }, "Names": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames", "traits": { "smithy.api#documentation": "

The names of the load balancers.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersOutput": { "type": "structure", "members": { "LoadBalancers": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancers", "traits": { "smithy.api#documentation": "

Information about the load balancers.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeRules": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeRulesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeRulesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Describes the specified rules or the rules for the specified listener. You must specify\n either a listener or rules.

", "smithy.api#examples": [ { "title": "To describe a rule", "documentation": "This example describes the specified rule.", "input": { "RuleArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" ] }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "path-pattern", "Values": [ "/img/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } }, { "title": "To describe rules for a Network Load Balancer listener", "documentation": "This example describes the rules for the specified Network Load Balancer listener, including rules that route based on source IP address type.", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/net/my-nlb/1234567890abcdef/1234567890abcdef" }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "source-ip", "SourceIpConfig": { "IpAddressType": "ipv4" } } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/aabbccdd11223344", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", "Type": "forward" } ] }, { "Priority": "20", "Conditions": [ { "Field": "source-ip", "SourceIpConfig": { "IpAddressType": "ipv6" } } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/eeff00112233aabb", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv6-targets/abcdef1234567890", "Type": "forward" } ] }, { "Priority": "default", "Conditions": [], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/default", "IsDefault": true, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ipv4-targets/1234567890abcdef", "Type": "forward" } ] } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "Rules" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeRulesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" } }, "RuleArns": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the rules.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeRulesOutput": { "type": "structure", "members": { "Rules": { "target": "com.amazonaws.elasticloadbalancingv2#Rules", "traits": { "smithy.api#documentation": "

Information about the rules.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeSSLPolicies": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#SSLPolicyNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the specified policies or all policies used for SSL negotiation.

\n

For more information, see Security policies in the Application Load Balancers Guide and\n Security policies in the Network Load Balancers Guide.

", "smithy.api#examples": [ { "title": "To describe a policy used for SSL negotiation", "documentation": "This example describes the specified policy used for SSL negotiation.", "input": { "Names": [ "ELBSecurityPolicy-2015-05" ] }, "output": { "SslPolicies": [ { "SslProtocols": [ "TLSv1", "TLSv1.1", "TLSv1.2" ], "Ciphers": [ { "Priority": 1, "Name": "ECDHE-ECDSA-AES128-GCM-SHA256" }, { "Priority": 2, "Name": "ECDHE-RSA-AES128-GCM-SHA256" }, { "Priority": 3, "Name": "ECDHE-ECDSA-AES128-SHA256" }, { "Priority": 4, "Name": "ECDHE-RSA-AES128-SHA256" }, { "Priority": 5, "Name": "ECDHE-ECDSA-AES128-SHA" }, { "Priority": 6, "Name": "ECDHE-RSA-AES128-SHA" }, { "Priority": 7, "Name": "DHE-RSA-AES128-SHA" }, { "Priority": 8, "Name": "ECDHE-ECDSA-AES256-GCM-SHA384" }, { "Priority": 9, "Name": "ECDHE-RSA-AES256-GCM-SHA384" }, { "Priority": 10, "Name": "ECDHE-ECDSA-AES256-SHA384" }, { "Priority": 11, "Name": "ECDHE-RSA-AES256-SHA384" }, { "Priority": 12, "Name": "ECDHE-RSA-AES256-SHA" }, { "Priority": 13, "Name": "ECDHE-ECDSA-AES256-SHA" }, { "Priority": 14, "Name": "AES128-GCM-SHA256" }, { "Priority": 15, "Name": "AES128-SHA256" }, { "Priority": 16, "Name": "AES128-SHA" }, { "Priority": 17, "Name": "AES256-GCM-SHA384" }, { "Priority": 18, "Name": "AES256-SHA256" }, { "Priority": 19, "Name": "AES256-SHA" } ], "Name": "ELBSecurityPolicy-2015-05" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyNames", "traits": { "smithy.api#documentation": "

The names of the policies.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } }, "LoadBalancerType": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", "traits": { "smithy.api#documentation": "

The type of load balancer. The default lists the SSL policies for all load\n balancers.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesOutput": { "type": "structure", "members": { "SslPolicies": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicies", "traits": { "smithy.api#documentation": "

Information about the security policies.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTags": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTagsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTagsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the tags for the specified Elastic Load Balancing resources. You can describe\n the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load\n Balancers, target groups, listeners, or rules.

", "smithy.api#examples": [ { "title": "To describe the tags assigned to a load balancer", "documentation": "This example describes the tags assigned to the specified load balancer.", "input": { "ResourceArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ] }, "output": { "TagDescriptions": [ { "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Tags": [ { "Key": "project", "Value": "lima" }, { "Key": "department", "Value": "digital-media" } ] } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#DescribeTagsInput": { "type": "structure", "members": { "ResourceArns": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a\n single call.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTagsOutput": { "type": "structure", "members": { "TagDescriptions": { "target": "com.amazonaws.elasticloadbalancingv2#TagDescriptions", "traits": { "smithy.api#documentation": "

Information about the tags.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the attributes for the specified target group.

\n

For more information, see the following:

\n ", "smithy.api#examples": [ { "title": "To describe target group attributes", "documentation": "This example describes the attributes of the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" }, "output": { "Attributes": [ { "Value": "false", "Key": "stickiness.enabled" }, { "Value": "300", "Key": "deregistration_delay.timeout_seconds" }, { "Value": "lb_cookie", "Key": "stickiness.type" }, { "Value": "86400", "Key": "stickiness.lb_cookie.duration_seconds" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributesInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", "traits": { "smithy.api#documentation": "

Information about the target group attributes

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroups": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the specified target groups or all of your target groups. By default, all target\n groups are described. Alternatively, you can specify one of the following to filter the\n results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of\n one or more target groups.

", "smithy.api#examples": [ { "title": "To describe a target group", "documentation": "This example describes the specified target group.", "input": { "TargetGroupArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" ] }, "output": { "TargetGroups": [ { "HealthCheckPath": "/", "HealthCheckIntervalSeconds": 30, "VpcId": "vpc-3ac0fb5f", "Protocol": "HTTP", "HealthCheckTimeoutSeconds": 5, "HealthCheckProtocol": "HTTP", "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "UnhealthyThresholdCount": 2, "HealthyThresholdCount": 5, "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Matcher": { "HttpCode": "200" }, "HealthCheckPort": "traffic-port", "Port": 80, "TargetGroupName": "my-targets" } ] } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "TargetGroups" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "TargetGroupArns": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups.

" } }, "Names": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNames", "traits": { "smithy.api#documentation": "

The names of the target groups.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsOutput": { "type": "structure", "members": { "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroups", "traits": { "smithy.api#documentation": "

Information about the target groups.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealth": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#HealthUnavailableException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidTargetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the health of the specified targets or all of your targets.

", "smithy.api#examples": [ { "title": "To describe the health of the targets for a target group", "documentation": "This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" }, "output": { "TargetHealthDescriptions": [ { "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "unused", "Reason": "Target.NotInUse", "Description": "Given target group is not configured to receive traffic from ELB" } }, { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } }, { "title": "To describe the health of a target", "documentation": "This example describes the health of the specified target. This target is healthy.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Targets": [ { "Id": "i-0f76fade", "Port": 80 } ] }, "output": { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } } ], "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.waiters#waitable": { "TargetDeregistered": { "acceptors": [ { "state": "success", "matcher": { "errorType": "InvalidTarget" } }, { "state": "success", "matcher": { "output": { "path": "TargetHealthDescriptions[].TargetHealth.State", "expected": "unused", "comparator": "allStringEquals" } } } ], "minDelay": 15 }, "TargetInService": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "TargetHealthDescriptions[].TargetHealth.State", "expected": "healthy", "comparator": "allStringEquals" } } }, { "state": "retry", "matcher": { "errorType": "InvalidInstance" } } ], "minDelay": 15 } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, "Targets": { "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", "traits": { "smithy.api#documentation": "

The targets.

" } }, "Include": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfDescribeTargetHealthIncludeOptions", "traits": { "smithy.api#documentation": "

Used to include anomaly detection information.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthInputIncludeEnum": { "type": "enum", "members": { "ANOMALY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AnomalyDetection" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "All" } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthOutput": { "type": "structure", "members": { "TargetHealthDescriptions": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthDescriptions", "traits": { "smithy.api#documentation": "

Information about the health of the targets.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociations": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociationsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociationsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes all resources associated with the specified trust store.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "TrustStoreAssociations", "pageSize": "PageSize" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociationsInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociationsOutput": { "type": "structure", "members": { "TrustStoreAssociations": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociations", "traits": { "smithy.api#documentation": "

Information about the resources the trust store is associated to.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocation": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

" } }, "RevocationId": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationId", "traits": { "smithy.api#documentation": "

The revocation ID of a revocation file in use.

" } }, "RevocationType": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationType", "traits": { "smithy.api#documentation": "

The type of revocation file.

" } }, "NumberOfRevokedEntries": { "target": "com.amazonaws.elasticloadbalancingv2#NumberOfRevokedEntries", "traits": { "smithy.api#documentation": "

The number of revoked certificates.

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

Information about the revocations used by a trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationResponse": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocation" } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocations": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#RevocationIdNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the revocation files in use by the specified trust store or revocation\n files.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "TrustStoreRevocations", "pageSize": "PageSize" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationsInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "RevocationIds": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationIds", "traits": { "smithy.api#documentation": "

The revocation IDs of the revocation files you want to describe.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationsOutput": { "type": "structure", "members": { "TrustStoreRevocations": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocationResponse", "traits": { "smithy.api#documentation": "

Information about the revocation file in the trust store.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStores": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoresInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoresOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes all trust stores for the specified account.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", "items": "TrustStores", "pageSize": "PageSize" } } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoresInput": { "type": "structure", "members": { "TrustStoreArns": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

" } }, "Names": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNames", "traits": { "smithy.api#documentation": "

The names of the trust stores.

" } }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous call.)

" } }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoresOutput": { "type": "structure", "members": { "TrustStores": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStores", "traits": { "smithy.api#documentation": "

Information about the trust stores.

" } }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results.\n Otherwise, this is null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#Description": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#DuplicateListenerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateListener", "httpResponseCode": 400 }, "smithy.api#documentation": "

A listener with the specified port already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#DuplicateLoadBalancerNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateLoadBalancerName", "httpResponseCode": 400 }, "smithy.api#documentation": "

A load balancer with the specified name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#DuplicateTagKeysException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateTagKeys", "httpResponseCode": 400 }, "smithy.api#documentation": "

A tag key was specified more than once.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#DuplicateTargetGroupNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateTargetGroupName", "httpResponseCode": 400 }, "smithy.api#documentation": "

A target group with the specified name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#DuplicateTrustStoreNameException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DuplicateTrustStoreName", "httpResponseCode": 400 }, "smithy.api#documentation": "

A trust store with the specified name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#ElasticLoadBalancing_v10": { "type": "service", "version": "2015-12-01", "operations": [ { "target": "com.amazonaws.elasticloadbalancingv2#AddListenerCertificates" }, { "target": "com.amazonaws.elasticloadbalancingv2#AddTags" }, { "target": "com.amazonaws.elasticloadbalancingv2#AddTrustStoreRevocations" }, { "target": "com.amazonaws.elasticloadbalancingv2#CreateListener" }, { "target": "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancer" }, { "target": "com.amazonaws.elasticloadbalancingv2#CreateRule" }, { "target": "com.amazonaws.elasticloadbalancingv2#CreateTargetGroup" }, { "target": "com.amazonaws.elasticloadbalancingv2#CreateTrustStore" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteListener" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancer" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteRule" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteSharedTrustStoreAssociation" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroup" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeleteTrustStore" }, { "target": "com.amazonaws.elasticloadbalancingv2#DeregisterTargets" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimits" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeCapacityReservation" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificates" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeListeners" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancerAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancers" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeRules" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeSSLPolicies" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTags" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroups" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealth" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreAssociations" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStoreRevocations" }, { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTrustStores" }, { "target": "com.amazonaws.elasticloadbalancingv2#GetResourcePolicy" }, { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundle" }, { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContent" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservation" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyIpPools" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListener" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyRule" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroup" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributes" }, { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTrustStore" }, { "target": "com.amazonaws.elasticloadbalancingv2#RegisterTargets" }, { "target": "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificates" }, { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTags" }, { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocations" }, { "target": "com.amazonaws.elasticloadbalancingv2#SetIpAddressType" }, { "target": "com.amazonaws.elasticloadbalancingv2#SetRulePriorities" }, { "target": "com.amazonaws.elasticloadbalancingv2#SetSecurityGroups" }, { "target": "com.amazonaws.elasticloadbalancingv2#SetSubnets" } ], "traits": { "aws.api#service": { "sdkId": "Elastic Load Balancing v2", "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancingV2", "cloudTrailEventSource": "elasticloadbalancing.amazonaws.com", "docId": "elasticloadbalancingv2-2015-12-01", "endpointPrefix": "elasticloadbalancing" }, "aws.auth#sigv4": { "name": "elasticloadbalancing" }, "aws.protocols#awsQuery": {}, "smithy.api#documentation": "Elastic Load Balancing\n

A load balancer distributes incoming traffic across targets, such as your EC2 instances.\n This enables you to increase the availability of your application. The load balancer also\n monitors the health of its registered targets and ensures that it routes traffic only to\n healthy targets. You configure your load balancer to accept incoming traffic by specifying one\n or more listeners, which are configured with a protocol and port number for connections from\n clients to the load balancer. You configure a target group with a protocol and port number for\n connections from the load balancer to the targets, and with health check settings to be used\n when checking the health status of the targets.

\n

Elastic Load Balancing supports the following types of load balancers: Application Load\n Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This\n reference covers the following load balancer types:

\n \n

For more information, see the Elastic Load Balancing User\n Guide.

\n

All Elastic Load Balancing operations are idempotent, which means that they complete at\n most one time. If you repeat an operation, it succeeds.

", "smithy.api#title": "Elastic Load Balancing", "smithy.api#xmlNamespace": { "uri": "http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" }, "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 ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "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://elasticloadbalancing-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://elasticloadbalancing.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticloadbalancing-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://elasticloadbalancing.{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://elasticloadbalancing.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "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://elasticloadbalancing-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://elasticloadbalancing.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticloadbalancing-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://elasticloadbalancing.{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://elasticloadbalancing.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-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://elasticloadbalancing-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://elasticloadbalancing.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticloadbalancing-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "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.elasticloadbalancingv2#EnablePrefixForIpv6SourceNatEnum": { "type": "enum", "members": { "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "on" } }, "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "off" } } } }, "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum": { "type": "enum", "members": { "on": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "on" } }, "off": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "off" } } } }, "com.amazonaws.elasticloadbalancingv2#ErrorDescription": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig": { "type": "structure", "members": { "MessageBody": { "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionMessage", "traits": { "smithy.api#documentation": "

The message.

" } }, "StatusCode": { "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionStatusCode", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The HTTP response code (2XX, 4XX, or 5XX).

", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType", "traits": { "smithy.api#documentation": "

The content type.

\n

Valid Values: text/plain | text/css | text/html | application/javascript |\n application/json

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

Information about an action that returns a custom HTTP response.

" } }, "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 } } }, "com.amazonaws.elasticloadbalancingv2#FixedResponseActionMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.elasticloadbalancingv2#FixedResponseActionStatusCode": { "type": "string", "traits": { "smithy.api#pattern": "^(2|4|5)\\d\\d$" } }, "com.amazonaws.elasticloadbalancingv2#ForwardActionConfig": { "type": "structure", "members": { "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupList", "traits": { "smithy.api#documentation": "

The target groups.

" } }, "TargetGroupStickinessConfig": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessConfig", "traits": { "smithy.api#documentation": "

The target group stickiness for the rule.

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

Information about a forward action.

" } }, "com.amazonaws.elasticloadbalancingv2#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#GetResourcePolicyInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#GetResourcePolicyOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource policy for a specified resource.

", "smithy.api#examples": [ { "title": "Retrieve a resource policy", "documentation": "This example retrieves the resource policy for the specified trust store.", "input": { "ResourceArn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:truststore/my-trust-store/73e2d6bc24d8a067" } } ] } }, "com.amazonaws.elasticloadbalancingv2#GetResourcePolicyInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#GetResourcePolicyOutput": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.elasticloadbalancingv2#Policy", "traits": { "smithy.api#documentation": "

The content of the resource policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundle": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundleInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundleOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the ca certificate bundle.

\n

This action returns a pre-signed S3 URI which is \n active for ten minutes.

" } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundleInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreCaCertificatesBundleOutput": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.elasticloadbalancingv2#Location", "traits": { "smithy.api#documentation": "

The ca certificate bundles Amazon S3 URI.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContent": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContentInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContentOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#RevocationIdNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Retrieves the specified revocation file.

\n

This action returns a pre-signed S3 URI which is \n active for ten minutes.

" } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContentInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "RevocationId": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The revocation ID of the revocation file.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#GetTrustStoreRevocationContentOutput": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.elasticloadbalancingv2#Location", "traits": { "smithy.api#documentation": "

The revocation files Amazon S3 URI.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#GrpcCode": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 5, "max": 300 } } }, "com.amazonaws.elasticloadbalancingv2#HealthCheckPort": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 2, "max": 10 } } }, "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 2, "max": 120 } } }, "com.amazonaws.elasticloadbalancingv2#HealthUnavailableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "HealthUnavailable", "httpResponseCode": 500 }, "smithy.api#documentation": "

The health of the specified targets could not be retrieved due to an internal\n error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.elasticloadbalancingv2#HostHeaderConditionConfig": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The host names. The maximum length of each string is 128 characters. The comparison is\n case insensitive. The following wildcard characters are supported: * (matches 0 or more\n characters) and ? (matches exactly 1 character). You must include at least one \".\" \n character. You can include only alphabetical characters after the final \".\" character.

\n

If you specify multiple strings, the condition is satisfied if one of the strings matches\n the host name.

" } }, "RegexValues": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The regular expressions to compare against the host header. The maximum length of each string is 128 characters.

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

Information about a host header condition.

" } }, "com.amazonaws.elasticloadbalancingv2#HostHeaderRewriteConfig": { "type": "structure", "members": { "Rewrites": { "target": "com.amazonaws.elasticloadbalancingv2#RewriteConfigList", "traits": { "smithy.api#documentation": "

The host header rewrite transform. Each transform consists of a regular expression to match and a replacement string.

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

Information about a host header rewrite transform. This transform matches a pattern in the host header in an HTTP request and replaces it with the specified string.

" } }, "com.amazonaws.elasticloadbalancingv2#HttpCode": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionConfig": { "type": "structure", "members": { "HttpHeaderName": { "target": "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionName", "traits": { "smithy.api#documentation": "

The name of the HTTP header field. The maximum length is 40 characters. The header name is\n case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not\n supported.

\n

You can't use an HTTP header condition to specify the host header. Instead, use a host condition.

" } }, "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The strings to compare against the value of the HTTP header. The maximum length of\n each string is 128 characters. The comparison strings are case insensitive. The following\n wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1\n character).

\n

If the same header appears multiple times in the request, we search them in order until a\n match is found.

\n

If you specify multiple strings, the condition is satisfied if one of the strings matches\n the value of the HTTP header. To require that all of the strings are a match, create one\n condition per string.

" } }, "RegexValues": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The regular expression to compare against the HTTP header. The maximum length of each string is 128 characters.

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

Information about an HTTP header condition.

\n

There is a set of standard HTTP header fields. You can also define custom HTTP header\n fields.

" } }, "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#HttpRequestMethodConditionConfig": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The name of the request method. The maximum length is 40 characters. The allowed characters\n are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not\n supported; therefore, the method name must be an exact match.

\n

If you specify multiple strings, the condition is satisfied if one of the strings matches\n the HTTP request method. We recommend that you route GET and HEAD requests in the same way,\n because the response to a HEAD request may be cached.

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

Information about an HTTP method condition.

\n

HTTP defines a set of request methods, also referred to as HTTP verbs. For more\n information, see the HTTP Method\n Registry. You can also define custom HTTP methods.

" } }, "com.amazonaws.elasticloadbalancingv2#IPv6Address": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#IgnoreClientCertificateExpiry": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#IncompatibleProtocolsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "IncompatibleProtocols", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified configuration is not valid with this protocol.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InsufficientCapacityException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientCapacity", "httpResponseCode": 500 }, "smithy.api#documentation": "

There is insufficient capacity to reserve.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.elasticloadbalancingv2#InvalidCaCertificatesBundleException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidCaCertificatesBundle", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified ca certificate bundle is in an invalid format, or corrupt.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidConfigurationRequest", "httpResponseCode": 400 }, "smithy.api#documentation": "

The requested configuration is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidLoadBalancerActionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidLoadBalancerAction", "httpResponseCode": 400 }, "smithy.api#documentation": "

The requested action is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidRevocationContentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidRevocationContent", "httpResponseCode": 400 }, "smithy.api#documentation": "

The provided revocation file is an invalid format, or uses an incorrect algorithm.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidSchemeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidScheme", "httpResponseCode": 400 }, "smithy.api#documentation": "

The requested scheme is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidSecurityGroupException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSecurityGroup", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified security group does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidSubnetException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSubnet", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified subnet is out of available addresses.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#InvalidTargetException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidTarget", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified target does not exist, is not in the same VPC as the target group, or has an\n unsupported instance type.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#IpAddress": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#IpAddressType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack" } }, "DUALSTACK_WITHOUT_PUBLIC_IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack-without-public-ipv4" } } } }, "com.amazonaws.elasticloadbalancingv2#IpamPoolId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^(ipam-pool-)[a-zA-Z0-9]+$" } }, "com.amazonaws.elasticloadbalancingv2#IpamPools": { "type": "structure", "members": { "Ipv4IpamPoolId": { "target": "com.amazonaws.elasticloadbalancingv2#IpamPoolId", "traits": { "smithy.api#documentation": "

The ID of the IPv4 IPAM pool.

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

An IPAM pool is a collection of IP address CIDRs. \n IPAM pools enable you to organize your IP addresses \n according to your routing and security needs.

" } }, "com.amazonaws.elasticloadbalancingv2#IsDefault": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaim": { "type": "structure", "members": { "Format": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimFormatEnum", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The format of the claim value.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the claim. You can't specify exp, iss, \n nbf, or iat because we validate them by default.

", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The claim value. The maximum size of the list is 10. \n Each value can be up to 256 characters in length.\n If the format is space-separated-values, the values\n can't include spaces.

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

Information about an additional claim to validate.

" } }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimFormatEnum": { "type": "enum", "members": { "SINGLE_STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "single-string" } }, "STRING_ARRAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "string-array" } }, "SPACE_SEPARATED_VALUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "space-separated-values" } } } }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimValues": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaimValue" } }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaims": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaim" } }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionConfig": { "type": "structure", "members": { "JwksEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionJwksEndpoint", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The JSON Web Key Set (JWKS) endpoint. This endpoint contains JSON Web Keys (JWK)\n that are used to validate signatures from the provider.

\n

This must be a full URL, including the HTTPS protocol, the domain, and the path.\n The maximum length is 256 characters.

", "smithy.api#required": {} } }, "Issuer": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionIssuer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The issuer of the JWT. The maximum length is 256 characters.

", "smithy.api#required": {} } }, "AdditionalClaims": { "target": "com.amazonaws.elasticloadbalancingv2#JwtValidationActionAdditionalClaims", "traits": { "smithy.api#documentation": "

Additional claims to validate. The maximum size of the list is 10.\n We validate the exp, iss, nbf, \n and iat claims by default.

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

Information about a JSON Web Token (JWT) validation action.

" } }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionIssuer": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#JwtValidationActionJwksEndpoint": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#LastModifiedTime": { "type": "timestamp" }, "com.amazonaws.elasticloadbalancingv2#Limit": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#Name", "traits": { "smithy.api#documentation": "

The name of the limit.

" } }, "Max": { "target": "com.amazonaws.elasticloadbalancingv2#Max", "traits": { "smithy.api#documentation": "

The maximum value of the limit.

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

Information about an Elastic Load Balancing resource limit for your Amazon Web Services\n account.

\n

For more information, see the following:

\n " } }, "com.amazonaws.elasticloadbalancingv2#Limits": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Limit" } }, "com.amazonaws.elasticloadbalancingv2#ListOfDescribeTargetHealthIncludeOptions": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthInputIncludeEnum" } }, "com.amazonaws.elasticloadbalancingv2#ListOfString": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue" } }, "com.amazonaws.elasticloadbalancingv2#Listener": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" } }, "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port on which the load balancer is listening.

" } }, "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol for connections from clients to the load balancer.

" } }, "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#documentation": "

[HTTPS or TLS listener] The default certificate for the listener.

" } }, "SslPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { "smithy.api#documentation": "

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are\n supported.

" } }, "DefaultActions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "

The default actions for the listener.

" } }, "AlpnPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { "smithy.api#documentation": "

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN)\n policy.

" } }, "MutualAuthentication": { "target": "com.amazonaws.elasticloadbalancingv2#MutualAuthenticationAttributes", "traits": { "smithy.api#documentation": "

The mutual authentication configuration information.

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

Information about a listener.

" } }, "com.amazonaws.elasticloadbalancingv2#ListenerArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ListenerArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn" } }, "com.amazonaws.elasticloadbalancingv2#ListenerAttribute": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttributeKey", "traits": { "smithy.api#documentation": "

The name of the attribute.

\n

The following attribute is supported by Network Load Balancers, and Gateway Load Balancers.

\n \n

The following attribute is only supported by Gateway Load Balancers:

\n \n

The following attributes are only supported by Application Load Balancers.

\n " } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

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

Information about a listener attribute.

" } }, "com.amazonaws.elasticloadbalancingv2#ListenerAttributeKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9._]+$" } }, "com.amazonaws.elasticloadbalancingv2#ListenerAttributeValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ListenerAttributes": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttribute" } }, "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ListenerNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified listener does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#Listeners": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Listener" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancer": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "DNSName": { "target": "com.amazonaws.elasticloadbalancingv2#DNSName", "traits": { "smithy.api#documentation": "

The public DNS name of the load balancer.

" } }, "CanonicalHostedZoneId": { "target": "com.amazonaws.elasticloadbalancingv2#CanonicalHostedZoneId", "traits": { "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

" } }, "CreatedTime": { "target": "com.amazonaws.elasticloadbalancingv2#CreatedTime", "traits": { "smithy.api#documentation": "

The date and time the load balancer was created.

" } }, "LoadBalancerName": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", "traits": { "smithy.api#documentation": "

The name of the load balancer.

" } }, "Scheme": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", "traits": { "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an\n Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes.\n Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of an\n internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

" } }, "VpcId": { "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" } }, "State": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerState", "traits": { "smithy.api#documentation": "

The state of the load balancer.

" } }, "Type": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", "traits": { "smithy.api#documentation": "

The type of load balancer.

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

The subnets for the load balancer.

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

The IDs of the security groups for the load balancer.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#documentation": "

The type of IP addresses used for public or private connections by the subnets \n attached to your load balancer.

\n

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), \n dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 \n (public IPv6 addresses and private IPv4 and IPv6 addresses).

\n

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 \n (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

" } }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", "traits": { "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the customer-owned address pool.

" } }, "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic", "traits": { "smithy.api#documentation": "

Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink.

" } }, "EnablePrefixForIpv6SourceNat": { "target": "com.amazonaws.elasticloadbalancingv2#EnablePrefixForIpv6SourceNatEnum", "traits": { "smithy.api#documentation": "

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix \n from each subnet for source NAT. The IP address type must be dualstack.\n The default value is off.

" } }, "IpamPools": { "target": "com.amazonaws.elasticloadbalancingv2#IpamPools", "traits": { "smithy.api#documentation": "

[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.

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

Information about a load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddress": { "type": "structure", "members": { "IpAddress": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddress", "traits": { "smithy.api#documentation": "

The static IP address.

" } }, "AllocationId": { "target": "com.amazonaws.elasticloadbalancingv2#AllocationId", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The allocation ID of the Elastic IP address for an\n internal-facing load balancer.

" } }, "PrivateIPv4Address": { "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" } }, "IPv6Address": { "target": "com.amazonaws.elasticloadbalancingv2#IPv6Address", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The IPv6 address.

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

Information about a static IP address for a load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddress" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttribute": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", "traits": { "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:

\n \n

The following attributes are supported by only Application Load Balancers:

\n \n

The following attributes are supported by only Network Load Balancers:

\n " } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

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

Information about a load balancer attribute.

" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9._]+$" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttribute" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "LoadBalancerNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified load balancer does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum": { "type": "enum", "members": { "INTERNET_FACING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "internet-facing" } }, "INTERNAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "internal" } } } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerState": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerStateEnum", "traits": { "smithy.api#documentation": "

The state code. The initial state of the load balancer is provisioning. After\n the load balancer is fully set up and ready to route traffic, its state is\n active. If load balancer is routing traffic but does not have the resources it\n needs to scale, its state isactive_impaired. If the load balancer could not be\n set up, its state is failed.

" } }, "Reason": { "target": "com.amazonaws.elasticloadbalancingv2#StateReason", "traits": { "smithy.api#documentation": "

A description of the state.

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

Information about the state of the load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerStateEnum": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active" } }, "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "provisioning" } }, "ACTIVE_IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active_impaired" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failed" } } } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum": { "type": "enum", "members": { "APPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application" } }, "NETWORK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "network" } }, "GATEWAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gateway" } } } }, "com.amazonaws.elasticloadbalancingv2#LoadBalancers": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancer" } }, "com.amazonaws.elasticloadbalancingv2#Location": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#Marker": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#Matcher": { "type": "structure", "members": { "HttpCode": { "target": "com.amazonaws.elasticloadbalancingv2#HttpCode", "traits": { "smithy.api#documentation": "

For Application Load Balancers, you can specify values between 200 and 499, with the\n default value being 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").

\n

For Network Load Balancers, you can specify values between 200 and 599, with the\n default value being 200-399. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").

\n

For Gateway Load Balancers, this must be \"200\u2013399\".

\n

Note that when using shorthand syntax, some values such as commas need to be\n escaped.

" } }, "GrpcCode": { "target": "com.amazonaws.elasticloadbalancingv2#GrpcCode", "traits": { "smithy.api#documentation": "

You can specify values between 0 and 99. You can specify multiple values (for example,\n \"0,1\") or a range of values (for example, \"0-5\"). The default value is 12.

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

The codes to use when checking for a successful response from a target. If the protocol\n version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.

" } }, "com.amazonaws.elasticloadbalancingv2#Max": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#MinimumLoadBalancerCapacity": { "type": "structure", "members": { "CapacityUnits": { "target": "com.amazonaws.elasticloadbalancingv2#CapacityUnits", "traits": { "smithy.api#documentation": "

The number of capacity units.

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

The minimum capacity for a load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#MitigationInEffectEnum": { "type": "enum", "members": { "YES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "yes" } }, "NO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "no" } } } }, "com.amazonaws.elasticloadbalancingv2#Mode": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservation": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservationInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservationOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#CapacityDecreaseRequestsLimitExceededException" }, { "target": "com.amazonaws.elasticloadbalancingv2#CapacityReservationPendingException" }, { "target": "com.amazonaws.elasticloadbalancingv2#CapacityUnitsLimitExceededException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InsufficientCapacityException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#PriorRequestNotCompleteException" } ], "traits": { "smithy.api#documentation": "

Modifies the capacity reservation of the specified load balancer.

\n

When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity \n or ResetCapacityReservation.

" } }, "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservationInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "MinimumLoadBalancerCapacity": { "target": "com.amazonaws.elasticloadbalancingv2#MinimumLoadBalancerCapacity", "traits": { "smithy.api#documentation": "

The minimum load balancer capacity reserved.

" } }, "ResetCapacityReservation": { "target": "com.amazonaws.elasticloadbalancingv2#ResetCapacityReservation", "traits": { "smithy.api#documentation": "

Resets the capacity reservation.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyCapacityReservationOutput": { "type": "structure", "members": { "LastModifiedTime": { "target": "com.amazonaws.elasticloadbalancingv2#LastModifiedTime", "traits": { "smithy.api#documentation": "

The last time the capacity reservation was modified.

" } }, "DecreaseRequestsRemaining": { "target": "com.amazonaws.elasticloadbalancingv2#DecreaseRequestsRemaining", "traits": { "smithy.api#documentation": "

The amount of daily capacity decreases remaining.

" } }, "MinimumLoadBalancerCapacity": { "target": "com.amazonaws.elasticloadbalancingv2#MinimumLoadBalancerCapacity", "traits": { "smithy.api#documentation": "

The requested minimum capacity reservation for the load balancer

" } }, "CapacityReservationState": { "target": "com.amazonaws.elasticloadbalancingv2#ZonalCapacityReservationStates", "traits": { "smithy.api#documentation": "

The state of the capacity reservation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyIpPools": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyIpPoolsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyIpPoolsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

[Application Load Balancers] Modify the IP pool associated to a load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#ModifyIpPoolsInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "IpamPools": { "target": "com.amazonaws.elasticloadbalancingv2#IpamPools", "traits": { "smithy.api#documentation": "

The IPAM pools to be modified.

" } }, "RemoveIpamPools": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveIpamPools", "traits": { "smithy.api#documentation": "

Remove the IP pools in use by the load balancer.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyIpPoolsOutput": { "type": "structure", "members": { "IpamPools": { "target": "com.amazonaws.elasticloadbalancingv2#IpamPools", "traits": { "smithy.api#documentation": "

The IPAM pool ID.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyListener": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListenerInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListenerOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ALPNPolicyNotSupportedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#CertificateNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#DuplicateListenerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#IncompatibleProtocolsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidLoadBalancerActionException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#SSLPolicyNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAssociationLimitException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyActionsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyCertificatesException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyListenersException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyUniqueTargetGroupsPerLoadBalancerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotReadyException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Replaces the specified properties of the specified listener. Any properties that you do\n not specify remain unchanged.

\n

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy\n and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP\n to TLS, you must add the security policy and default certificate properties.

\n

To add an item to a list, remove an item from a list, or update an item in a list, you\n must provide the entire list. For example, to add an action, specify a list with the current\n actions plus the new action.

", "smithy.api#examples": [ { "title": "To change the default action for a listener", "documentation": "This example changes the default action for the specified listener.", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", "DefaultActions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f" } ] }, "output": { "Listeners": [ { "Protocol": "HTTP", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", "Type": "forward" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Port": 80, "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" } ] } }, { "title": "To change the server certificate", "documentation": "This example changes the server certificate for the specified HTTPS listener.", "input": { "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" } ] }, "output": { "Listeners": [ { "Protocol": "HTTPS", "DefaultActions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ], "SslPolicy": "ELBSecurityPolicy-2015-05", "Certificates": [ { "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" } ], "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Port": 443, "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the specified attributes of the specified listener.

" } }, "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttributes", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The listener attributes.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyListenerAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerAttributes", "traits": { "smithy.api#documentation": "

Information about the listener attributes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyListenerInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port for connections from clients to the load balancer. You can't specify a port for\n a Gateway Load Balancer.

" } }, "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol for connections from clients to the load balancer. Application Load Balancers\n support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP,\n TCP_UDP, QUIC, and TCP_QUIC protocols. You can\u2019t change the protocol to UDP, TCP_UDP, QUIC, or TCP_QUIC if dual-stack mode is\n enabled. You can't specify a protocol for a Gateway Load Balancer.

" } }, "SslPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported.

\n

For more information, see Security policies in the Application Load Balancers Guide or\n Security policies in the Network Load Balancers Guide.

" } }, "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide\n exactly one certificate. Set CertificateArn to the certificate ARN but do not set\n IsDefault.

" } }, "DefaultActions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "

The actions for the default rule.

" } }, "AlpnPolicy": { "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { "smithy.api#documentation": "

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You\n can specify one policy name. The following are the possible values:

\n \n

For more information, see ALPN\n policies in the Network Load Balancers Guide.

" } }, "MutualAuthentication": { "target": "com.amazonaws.elasticloadbalancingv2#MutualAuthenticationAttributes", "traits": { "smithy.api#documentation": "

[HTTPS and TLS listeners] The mutual authentication configuration information.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyListenerOutput": { "type": "structure", "members": { "Listeners": { "target": "com.amazonaws.elasticloadbalancingv2#Listeners", "traits": { "smithy.api#documentation": "

Information about the modified listener.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the specified attributes of the specified Application Load Balancer, Network Load\n Balancer, or Gateway Load Balancer.

\n

If any of the specified attributes can't be modified as requested, the call fails. Any\n existing attributes that you do not modify retain their current values.

", "smithy.api#examples": [ { "title": "To enable deletion protection", "documentation": "This example enables deletion protection for the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Attributes": [ { "Key": "deletion_protection.enabled", "Value": "true" } ] }, "output": { "Attributes": [ { "Value": "true", "Key": "deletion_protection.enabled" }, { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "", "Key": "access_logs.s3.bucket" } ] } }, { "title": "To change the idle timeout", "documentation": "This example changes the idle timeout value for the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Attributes": [ { "Key": "idle_timeout.timeout_seconds", "Value": "30" } ] }, "output": { "Attributes": [ { "Value": "30", "Key": "idle_timeout.timeout_seconds" }, { "Value": "false", "Key": "access_logs.s3.enabled" }, { "Value": "", "Key": "access_logs.s3.prefix" }, { "Value": "true", "Key": "deletion_protection.enabled" }, { "Value": "", "Key": "access_logs.s3.bucket" } ] } }, { "title": "To enable access logs", "documentation": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Attributes": [ { "Key": "access_logs.s3.enabled", "Value": "true" }, { "Key": "access_logs.s3.bucket", "Value": "my-loadbalancer-logs" }, { "Key": "access_logs.s3.prefix", "Value": "myapp" } ] }, "output": { "Attributes": [ { "Value": "true", "Key": "access_logs.s3.enabled" }, { "Value": "my-load-balancer-logs", "Key": "access_logs.s3.bucket" }, { "Value": "myapp", "Key": "access_logs.s3.prefix" }, { "Value": "60", "Key": "idle_timeout.timeout_seconds" }, { "Value": "false", "Key": "deletion_protection.enabled" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The load balancer attributes.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes", "traits": { "smithy.api#documentation": "

Information about the load balancer attributes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyRule": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyRuleInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyRuleOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#IncompatibleProtocolsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidLoadBalancerActionException" }, { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAssociationLimitException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyActionsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyUniqueTargetGroupsPerLoadBalancerException" }, { "target": "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException" } ], "traits": { "smithy.api#documentation": "

Replaces the specified properties of the specified rule. Any properties that you do not\n specify are unchanged.

\n

To add an item to a list, remove an item from a list, or update an item in a list, you\n must provide the entire list. For example, to add an action, specify a list with the current\n actions plus the new action.

", "smithy.api#examples": [ { "title": "To modify a rule", "documentation": "This example modifies the condition for the specified rule.", "input": { "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", "Conditions": [ { "Field": "path-pattern", "Values": [ "/images/*" ] } ] }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "path-pattern", "Values": [ "/images/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } }, { "title": "To modify a Network Load Balancer listener rule", "documentation": "This example modifies an NLB listener rule to forward traffic to a different target group.", "input": { "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", "Actions": [ { "Type": "forward", "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-ipv4-targets/1234567890abcdef" } ] }, "output": { "Rules": [ { "Priority": "10", "Conditions": [ { "Field": "source-ip", "SourceIpConfig": { "IpAddressType": "ipv4" } } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/net/my-nlb/1234567890abcdef/1234567890abcdef/1234567890abcdef", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-ipv4-targets/1234567890abcdef", "Type": "forward" } ] } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#ModifyRuleInput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", "smithy.api#required": {} } }, "Conditions": { "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { "smithy.api#documentation": "

The conditions.

" } }, "Actions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "

The actions.

" } }, "Transforms": { "target": "com.amazonaws.elasticloadbalancingv2#RuleTransformList", "traits": { "smithy.api#documentation": "

The transforms to apply to requests that match this rule. You can add one host header rewrite transform \n and one URL rewrite transform. If you specify Transforms, you can't specify ResetTransforms.

" } }, "ResetTransforms": { "target": "com.amazonaws.elasticloadbalancingv2#ResetTransforms", "traits": { "smithy.api#documentation": "

Indicates whether to remove all transforms from the rule. If you specify ResetTransforms, \n you can't specify Transforms.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyRuleOutput": { "type": "structure", "members": { "Rules": { "target": "com.amazonaws.elasticloadbalancingv2#Rules", "traits": { "smithy.api#documentation": "

Information about the modified rule.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroup": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the health checks used when evaluating the health state of the targets in the\n specified target group.

", "smithy.api#examples": [ { "title": "To modify the health check configuration for a target group", "documentation": "This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", "HealthCheckProtocol": "HTTPS", "HealthCheckPort": "443" }, "output": { "TargetGroups": [ { "HealthCheckIntervalSeconds": 30, "VpcId": "vpc-3ac0fb5f", "Protocol": "HTTPS", "HealthCheckTimeoutSeconds": 5, "HealthCheckProtocol": "HTTPS", "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "UnhealthyThresholdCount": 2, "HealthyThresholdCount": 5, "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", "Matcher": { "HttpCode": "200" }, "HealthCheckPort": "443", "Port": 443, "TargetGroupName": "my-https-targets" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributes": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" } ], "traits": { "smithy.api#documentation": "

Modifies the specified attributes of the specified target group.

", "smithy.api#examples": [ { "title": "To modify the deregistration delay timeout", "documentation": "This example sets the deregistration delay timeout to the specified value for the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Attributes": [ { "Key": "deregistration_delay.timeout_seconds", "Value": "600" } ] }, "output": { "Attributes": [ { "Value": "false", "Key": "stickiness.enabled" }, { "Value": "600", "Key": "deregistration_delay.timeout_seconds" }, { "Value": "lb_cookie", "Key": "stickiness.type" }, { "Value": "86400", "Key": "stickiness.lb_cookie.duration_seconds" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The target group attributes.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesOutput": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", "traits": { "smithy.api#documentation": "

Information about the target group attributes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, "HealthCheckProtocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets. For\n Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load\n Balancers, the default is TCP. The TCP protocol is not supported for health checks if the\n protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the\n protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC\n protocols are not supported for health checks.

" } }, "HealthCheckPort": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets.

" } }, "HealthCheckPath": { "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS health checks] The destination for health checks on the targets.

\n

[HTTP1 or HTTP2 protocol version] The ping path. The default is /.

\n

[GRPC protocol version] The path of a custom health check method with the format\n /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

" } }, "HealthCheckEnabled": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { "smithy.api#documentation": "

Indicates whether health checks are enabled. If the target type is lambda,\n health checks are disabled by default but can be enabled. If the target type is\n instance, ip, or alb, health checks are always\n enabled and can't be disabled.

" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target.

" } }, "HealthCheckTimeoutSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means\n a failed health check.

" } }, "HealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an unhealthy\n target healthy.

" } }, "UnhealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy.

" } }, "Matcher": { "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful \n response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range \n is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target \n groups with a protocol of GENEVE, the range is 200-399.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupOutput": { "type": "structure", "members": { "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroups", "traits": { "smithy.api#documentation": "

Information about the modified target group.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTrustStore": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTrustStoreInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#ModifyTrustStoreOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#CaCertificatesBundleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidCaCertificatesBundleException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Update the ca certificate bundle for the specified trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#ModifyTrustStoreInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3Bucket": { "target": "com.amazonaws.elasticloadbalancingv2#S3Bucket", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 bucket for the ca certificates bundle.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3Key": { "target": "com.amazonaws.elasticloadbalancingv2#S3Key", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 path for the ca certificates bundle.

", "smithy.api#required": {} } }, "CaCertificatesBundleS3ObjectVersion": { "target": "com.amazonaws.elasticloadbalancingv2#S3ObjectVersion", "traits": { "smithy.api#documentation": "

The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#ModifyTrustStoreOutput": { "type": "structure", "members": { "TrustStores": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStores", "traits": { "smithy.api#documentation": "

Information about the modified trust store.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#MutualAuthenticationAttributes": { "type": "structure", "members": { "Mode": { "target": "com.amazonaws.elasticloadbalancingv2#Mode", "traits": { "smithy.api#documentation": "

The client certificate handling method. The default value is off.

\n

[Application Load Balancers] The possible values are off,\n passthrough, and verify.

\n

[Network Load Balancers] The possible values are off and\n verify.

" } }, "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

" } }, "IgnoreClientCertificateExpiry": { "target": "com.amazonaws.elasticloadbalancingv2#IgnoreClientCertificateExpiry", "traits": { "smithy.api#documentation": "

Indicates whether expired client certificates are ignored.

" } }, "TrustStoreAssociationStatus": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationStatusEnum", "traits": { "smithy.api#documentation": "

Indicates a shared trust stores association status.

" } }, "AdvertiseTrustStoreCaNames": { "target": "com.amazonaws.elasticloadbalancingv2#AdvertiseTrustStoreCaNamesEnum", "traits": { "smithy.api#documentation": "

Indicates whether trust store CA certificate names are advertised.

" } }, "ClientCertificateIdentityFilters": { "target": "com.amazonaws.elasticloadbalancingv2#ClientCertificateIdentityFilters", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The client certificate identity filters. The load balancer\n admits a connection only if the client certificate matches at least one filter. If you\n don't specify any filters, the load balancer admits every client certificate that passes\n trust store validation and revocation checks.

\n

You can specify filters only when the mode is verify. You can specify up\n to 100 filters per listener.

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

Information about the mutual authentication attributes of a listener.

" } }, "com.amazonaws.elasticloadbalancingv2#Name": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#NumberOfCaCertificates": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#NumberOfRevokedEntries": { "type": "long" }, "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationNotPermitted", "httpResponseCode": 400 }, "smithy.api#documentation": "

This operation is not allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#OutpostId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#PageSize": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 400 } } }, "com.amazonaws.elasticloadbalancingv2#Path": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.elasticloadbalancingv2#PathPatternConditionConfig": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The path patterns to compare against the request URL. The maximum length of each\n string is 128 characters. The comparison is case sensitive. The following wildcard characters\n are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

\n

If you specify multiple strings, the condition is satisfied if one of them matches the\n request URL. The path pattern is compared only to the path of the URL, not to its query\n string. To compare against the query string, use a query string condition.

" } }, "RegexValues": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The regular expressions to compare against the request URL. The maximum length of each string is 128 characters.

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

Information about a path pattern condition.

" } }, "com.amazonaws.elasticloadbalancingv2#Policy": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticloadbalancingv2#Port": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.elasticloadbalancingv2#PriorRequestNotCompleteException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "PriorRequestNotComplete", "httpResponseCode": 429 }, "smithy.api#documentation": "

This operation is not allowed while a prior request has not been completed.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.elasticloadbalancingv2#PriorityInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "PriorityInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified priority is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ProtocolEnum": { "type": "enum", "members": { "HTTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP" } }, "HTTPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPS" } }, "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP" } }, "TLS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS" } }, "UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UDP" } }, "TCP_UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP_UDP" } }, "GENEVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GENEVE" } }, "QUIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUIC" } }, "TCP_QUIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP_QUIC" } } } }, "com.amazonaws.elasticloadbalancingv2#ProtocolVersion": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#QueryStringConditionConfig": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePairList", "traits": { "smithy.api#documentation": "

The key/value pairs or values to find in the query string. The maximum length of\n each string is 128 characters. The comparison is case insensitive. The following wildcard\n characters are supported: * (matches 0 or more characters) and ? (matches exactly 1\n character). To search for a literal '*' or '?' character in a query string, you must escape\n these characters in Values using a '\\' character.

\n

If you specify multiple key/value pairs or values, the condition is satisfied if one of\n them is found in the query string.

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

Information about a query string condition.

\n

The query string component of a URI starts after the first '?' character and is terminated\n by either a '#' character or the end of the URI. A typical query string contains key/value\n pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any\n character can be percentage encoded.

" } }, "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePair": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { "smithy.api#documentation": "

The key. You can omit the key.

" } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { "smithy.api#documentation": "

The value.

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

Information about a key/value pair.

" } }, "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePairList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePair" } }, "com.amazonaws.elasticloadbalancingv2#QuicServerId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig": { "type": "structure", "members": { "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol", "traits": { "smithy.api#documentation": "

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\n HTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP.

" } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionPort", "traits": { "smithy.api#documentation": "

The port. You can specify a value from 1 to 65535 or #{port}.

" } }, "Host": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionHost", "traits": { "smithy.api#documentation": "

The hostname. This component is not percent-encoded. The hostname can contain\n #{host}.

" } }, "Path": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionPath", "traits": { "smithy.api#documentation": "

The absolute path, starting with the leading \"/\". This component is not percent-encoded.\n The path can contain #{host}, #{path}, and #{port}.

" } }, "Query": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionQuery", "traits": { "smithy.api#documentation": "

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include\n the leading \"?\", as it is automatically added. You can specify any of the reserved\n keywords.

" } }, "StatusCode": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionStatusCodeEnum", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP\n 302).

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

Information about a redirect action.

\n

A URI consists of the following components: protocol://hostname:port/path?query. You must\n modify at least one of the following components to avoid a redirect loop: protocol, hostname,\n port, or path. Any components that you do not modify retain their original values.

\n

You can reuse URI components using the following reserved keywords:

\n \n

For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\",\n or the query to \"#{query}&value=xyz\".

" } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionHost": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionPath": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionPort": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol": { "type": "string", "traits": { "smithy.api#pattern": "^(HTTPS?|#\\{protocol\\})$" } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionQuery": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.elasticloadbalancingv2#RedirectActionStatusCodeEnum": { "type": "enum", "members": { "HTTP_301": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP_301" } }, "HTTP_302": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP_302" } } } }, "com.amazonaws.elasticloadbalancingv2#RegisterTargets": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#RegisterTargetsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#RegisterTargetsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidTargetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" } ], "traits": { "smithy.api#documentation": "

Registers the specified targets with the specified target group.

\n

If the target is an EC2 instance, it must be in the running state when you\n register it.

\n

By default, the load balancer routes requests to registered targets using the protocol and\n port for the target group. Alternatively, you can override the port for a target when you\n register it. You can register each EC2 instance or IP address with the same target group\n multiple times using different ports.

\n

For more information, see the following:

\n ", "smithy.api#examples": [ { "title": "To register targets with a target group", "documentation": "This example registers the specified instances with the specified target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Targets": [ { "Id": "i-80c8dd94" }, { "Id": "i-ceddcd4d" } ] } }, { "title": "To register targets with a target group using port overrides", "documentation": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", "input": { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", "Targets": [ { "Id": "i-80c8dd94", "Port": 80 }, { "Id": "i-80c8dd94", "Port": 766 } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#RegisterTargetsInput": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, "Targets": { "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The targets.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#RegisterTargetsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveIpamPoolEnum": { "type": "enum", "members": { "ipv4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } } } }, "com.amazonaws.elasticloadbalancingv2#RemoveIpamPools": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveIpamPoolEnum" } }, "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificates": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" } ], "traits": { "smithy.api#documentation": "

Removes the specified certificate from the certificate list for the specified HTTPS or TLS\n listener.

" } }, "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesInput": { "type": "structure", "members": { "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, "Certificates": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The certificate to remove. You can specify one certificate per call. Set\n CertificateArn to the certificate ARN but do not set\n IsDefault.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveTags": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTagsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTagsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#ListenerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes the specified tags from the specified Elastic Load Balancing resources. You can\n remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway\n Load Balancers, target groups, listeners, or rules.

", "smithy.api#examples": [ { "title": "To remove tags from a load balancer", "documentation": "This example removes the specified tags from the specified load balancer.", "input": { "ResourceArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ], "TagKeys": [ "project", "department" ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#RemoveTagsInput": { "type": "structure", "members": { "ResourceArns": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.elasticloadbalancingv2#TagKeys", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The tag keys for the tags to remove.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveTagsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocations": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocationsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocationsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#RevocationIdNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes the specified revocation file from the specified trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocationsInput": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

", "smithy.api#required": {} } }, "RevocationIds": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationIds", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The revocation IDs of the revocation files you want to remove.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#RemoveTrustStoreRevocationsOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#ResetCapacityReservation": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#ResetTransforms": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#ResourceArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ResourceArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn" } }, "com.amazonaws.elasticloadbalancingv2#ResourceInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "

A specified resource is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified resource does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#RevocationContent": { "type": "structure", "members": { "S3Bucket": { "target": "com.amazonaws.elasticloadbalancingv2#S3Bucket", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket for the revocation file.

" } }, "S3Key": { "target": "com.amazonaws.elasticloadbalancingv2#S3Key", "traits": { "smithy.api#documentation": "

The Amazon S3 path for the revocation file.

" } }, "S3ObjectVersion": { "target": "com.amazonaws.elasticloadbalancingv2#S3ObjectVersion", "traits": { "smithy.api#documentation": "

The Amazon S3 object version of the revocation file.

" } }, "RevocationType": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationType", "traits": { "smithy.api#documentation": "

The type of revocation file.

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

Information about a revocation file.

" } }, "com.amazonaws.elasticloadbalancingv2#RevocationContentNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RevocationContentNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified revocation file does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#RevocationContents": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationContent" } }, "com.amazonaws.elasticloadbalancingv2#RevocationId": { "type": "long" }, "com.amazonaws.elasticloadbalancingv2#RevocationIdNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RevocationIdNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified revocation ID does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#RevocationIds": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationId" } }, "com.amazonaws.elasticloadbalancingv2#RevocationType": { "type": "enum", "members": { "CRL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRL" } } } }, "com.amazonaws.elasticloadbalancingv2#RewriteConfig": { "type": "structure", "members": { "Regex": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The regular expression to match in the input string. The maximum length of the string is 1,024 characters.

", "smithy.api#required": {} } }, "Replace": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The replacement string to use when rewriting the matched input. The maximum length of the string is 1,024 characters. \n You can specify capture groups in the regular expression (for example, $1 and $2).

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

Information about a rewrite transform. This transform matches a pattern and replaces it with the specified string.

" } }, "com.amazonaws.elasticloadbalancingv2#RewriteConfigList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RewriteConfig" } }, "com.amazonaws.elasticloadbalancingv2#Rule": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#String", "traits": { "smithy.api#documentation": "

The priority.

" } }, "Conditions": { "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { "smithy.api#documentation": "

The conditions. Each rule can include zero or one of the following conditions:\n http-request-method, host-header, path-pattern, and\n source-ip, and zero or more of the following conditions:\n http-header and query-string.

" } }, "Actions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "

The actions. Each rule must include exactly one of the following types of actions:\n forward, redirect, or fixed-response, and it must be\n the last action to be performed.

" } }, "IsDefault": { "target": "com.amazonaws.elasticloadbalancingv2#IsDefault", "traits": { "smithy.api#documentation": "

Indicates whether this is the default rule.

" } }, "Transforms": { "target": "com.amazonaws.elasticloadbalancingv2#RuleTransformList", "traits": { "smithy.api#documentation": "

The transforms for the rule.

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

Information about a rule.

" } }, "com.amazonaws.elasticloadbalancingv2#RuleArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#RuleArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn" } }, "com.amazonaws.elasticloadbalancingv2#RuleCondition": { "type": "structure", "members": { "Field": { "target": "com.amazonaws.elasticloadbalancingv2#ConditionFieldName", "traits": { "smithy.api#documentation": "

The name of the field. The possible values are:

\n " } }, "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The condition value. Specify only when Field is host-header or\n path-pattern. Alternatively, to specify multiple host names or multiple path\n patterns, use HostHeaderConfig or PathPatternConfig.

\n

If Field is host-header and you are not using\n HostHeaderConfig, you can specify a single host name (for example,\n my.example.com) in Values. A host name is case insensitive, can be up to 128\n characters in length, and can contain any of the following characters.

\n \n

If Field is path-pattern and you are not using\n PathPatternConfig, you can specify a single path pattern (for example, /img/*)\n in Values. A path pattern is case-sensitive, can be up to 128 characters in\n length, and can contain any of the following characters.

\n " } }, "HostHeaderConfig": { "target": "com.amazonaws.elasticloadbalancingv2#HostHeaderConditionConfig", "traits": { "smithy.api#documentation": "

Information for a host header condition. Specify only when Field is\n host-header.

" } }, "PathPatternConfig": { "target": "com.amazonaws.elasticloadbalancingv2#PathPatternConditionConfig", "traits": { "smithy.api#documentation": "

Information for a path pattern condition. Specify only when Field is\n path-pattern.

" } }, "HttpHeaderConfig": { "target": "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionConfig", "traits": { "smithy.api#documentation": "

Information for an HTTP header condition. Specify only when Field is\n http-header.

" } }, "QueryStringConfig": { "target": "com.amazonaws.elasticloadbalancingv2#QueryStringConditionConfig", "traits": { "smithy.api#documentation": "

Information for a query string condition. Specify only when Field is\n query-string.

" } }, "HttpRequestMethodConfig": { "target": "com.amazonaws.elasticloadbalancingv2#HttpRequestMethodConditionConfig", "traits": { "smithy.api#documentation": "

Information for an HTTP method condition. Specify only when Field is\n http-request-method.

" } }, "SourceIpConfig": { "target": "com.amazonaws.elasticloadbalancingv2#SourceIpConditionConfig", "traits": { "smithy.api#documentation": "

Information for a source IP condition. Specify only when Field is\n source-ip.

" } }, "RegexValues": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The regular expressions to match against the condition field. The maximum length of each string is 128 characters.\n Specify only when Field is http-header, host-header, or path-pattern.

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

Information about a condition for a rule.

\n

Each rule can optionally include up to one of each of the following conditions:\n http-request-method, host-header, path-pattern, and\n source-ip. Each rule can also optionally include one or more of each of the\n following conditions: http-header and query-string. Note that the\n value for a condition can't be empty.

\n

For Network Load Balancer listener rules, the only supported condition is\n source-ip. Use SourceIpConfig with IpAddressType to\n match on the IP address type of the source traffic (ipv4 or\n ipv6).

\n

For more information, see Quotas for your\n Application Load Balancers.

" } }, "com.amazonaws.elasticloadbalancingv2#RuleConditionList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RuleCondition" } }, "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RuleNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified rule does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#RulePriority": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50000 } } }, "com.amazonaws.elasticloadbalancingv2#RulePriorityList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RulePriorityPair" } }, "com.amazonaws.elasticloadbalancingv2#RulePriorityPair": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", "traits": { "smithy.api#documentation": "

The rule priority.

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

Information about the priorities for the rules for a listener.

" } }, "com.amazonaws.elasticloadbalancingv2#RuleTransform": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.elasticloadbalancingv2#TransformTypeEnum", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of transform.

\n ", "smithy.api#required": {} } }, "HostHeaderRewriteConfig": { "target": "com.amazonaws.elasticloadbalancingv2#HostHeaderRewriteConfig", "traits": { "smithy.api#documentation": "

Information about a host header rewrite transform. This transform modifies the host header in an HTTP request.\n Specify only when Type is host-header-rewrite.

" } }, "UrlRewriteConfig": { "target": "com.amazonaws.elasticloadbalancingv2#UrlRewriteConfig", "traits": { "smithy.api#documentation": "

Information about a URL rewrite transform. This transform modifies the request URL.\n Specify only when Type is url-rewrite.

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

Information about a transform to apply to requests that match a rule. Transforms are applied to requests before they are sent to targets.

" } }, "com.amazonaws.elasticloadbalancingv2#RuleTransformList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#RuleTransform" } }, "com.amazonaws.elasticloadbalancingv2#Rules": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Rule" } }, "com.amazonaws.elasticloadbalancingv2#S3Bucket": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#S3Key": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#S3ObjectVersion": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SSLPolicyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SSLPolicyNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified SSL policy does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#SecurityGroupId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroupId" } }, "com.amazonaws.elasticloadbalancingv2#SetIpAddressType": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSubnetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Sets the type of IP addresses used by the subnets of the specified load balancer.

" } }, "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The IP address type. Internal load balancers must use ipv4.

\n

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), \n dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 \n (public IPv6 addresses and private IPv4 and IPv6 addresses).

\n

Application Load Balancer authentication supports IPv4 addresses only when \n connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public \n IPv4 address the load balancer can't complete the authentication process, resulting \n in HTTP 500 errors.

\n

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 \n (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeOutput": { "type": "structure", "members": { "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#SetRulePriorities": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#SetRulePrioritiesInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#SetRulePrioritiesOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#OperationNotPermittedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#PriorityInUseException" }, { "target": "com.amazonaws.elasticloadbalancingv2#RuleNotFoundException" } ], "traits": { "smithy.api#documentation": "

Sets the priorities of the specified rules.

\n

You can reorder the rules as long as there are no priority conflicts in the new order. Any\n existing rules that you do not specify retain their current priority.

", "smithy.api#examples": [ { "title": "To set the rule priority", "documentation": "This example sets the priority of the specified rule.", "input": { "RulePriorities": [ { "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", "Priority": 5 } ] }, "output": { "Rules": [ { "Priority": "5", "Conditions": [ { "Field": "path-pattern", "Values": [ "/img/*" ] } ], "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", "IsDefault": false, "Actions": [ { "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "Type": "forward" } ] } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#SetRulePrioritiesInput": { "type": "structure", "members": { "RulePriorities": { "target": "com.amazonaws.elasticloadbalancingv2#RulePriorityList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The rule priorities.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#SetRulePrioritiesOutput": { "type": "structure", "members": { "Rules": { "target": "com.amazonaws.elasticloadbalancingv2#Rules", "traits": { "smithy.api#documentation": "

Information about the rules.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#SetSecurityGroups": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSecurityGroupException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" } ], "traits": { "smithy.api#documentation": "

Associates the specified security groups with the specified Application Load Balancer or\n Network Load Balancer. The specified security groups override the previously associated\n security groups.

\n

You can't perform this operation on a Network Load Balancer unless you specified a\n security group for the load balancer when you created it.

\n

You can't associate a security group with a Gateway Load Balancer.

", "smithy.api#examples": [ { "title": "To associate a security group with a load balancer", "documentation": "This example associates the specified security group with the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "SecurityGroups": [ "sg-5943793c" ] }, "output": { "SecurityGroupIds": [ "sg-5943793c" ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "SecurityGroups": { "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The IDs of the security groups.

", "smithy.api#required": {} } }, "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum", "traits": { "smithy.api#documentation": "

Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink. Applies only if the load balancer \n has an associated security group. The default is on.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsOutput": { "type": "structure", "members": { "SecurityGroupIds": { "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", "traits": { "smithy.api#documentation": "

The IDs of the security groups associated with the load balancer.

" } }, "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum", "traits": { "smithy.api#documentation": "

Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#SetSubnets": { "type": "operation", "input": { "target": "com.amazonaws.elasticloadbalancingv2#SetSubnetsInput" }, "output": { "target": "com.amazonaws.elasticloadbalancingv2#SetSubnetsOutput" }, "errors": [ { "target": "com.amazonaws.elasticloadbalancingv2#AllocationIdNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZoneNotSupportedException" }, { "target": "com.amazonaws.elasticloadbalancingv2#CapacityReservationPendingException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, { "target": "com.amazonaws.elasticloadbalancingv2#InvalidSubnetException" }, { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNotFoundException" }, { "target": "com.amazonaws.elasticloadbalancingv2#SubnetNotFoundException" } ], "traits": { "smithy.api#documentation": "

Enables the Availability Zones for the specified public subnets for the specified\n Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets \n replace the previously enabled subnets.

", "smithy.api#examples": [ { "title": "To enable Availability Zones for a load balancer", "documentation": "This example enables the Availability Zones for the specified subnets for the specified load balancer.", "input": { "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", "Subnets": [ "subnet-8360a9e7", "subnet-b7d581c0" ] }, "output": { "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } } ] } }, "com.amazonaws.elasticloadbalancingv2#SetSubnetsInput": { "type": "structure", "members": { "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.\n You must include all subnets that were enabled previously, with their existing configurations, \n plus any additional subnets.

" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You can't specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type.

\n

[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), \n dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 \n (public IPv6 addresses and private IPv4 and IPv6 addresses).

\n

[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 \n (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).

" } }, "EnablePrefixForIpv6SourceNat": { "target": "com.amazonaws.elasticloadbalancingv2#EnablePrefixForIpv6SourceNatEnum", "traits": { "smithy.api#documentation": "

[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix \n from each subnet for source NAT. The IP address type must be dualstack.\n The default value is off.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.elasticloadbalancingv2#SetSubnetsOutput": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", "traits": { "smithy.api#documentation": "

Information about the subnets.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type.

" } }, "EnablePrefixForIpv6SourceNat": { "target": "com.amazonaws.elasticloadbalancingv2#EnablePrefixForIpv6SourceNatEnum", "traits": { "smithy.api#documentation": "

[Network Load Balancers] Indicates whether to use an IPv6 prefix from each subnet for source NAT.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.elasticloadbalancingv2#SourceIpAddressTypeEnum": { "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.elasticloadbalancingv2#SourceIpConditionConfig": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.

\n

If you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n an HTTP header condition.

\n

The total number of values must be less than, or equal to five.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#SourceIpAddressTypeEnum", "traits": { "smithy.api#documentation": "

The IP address type for Network Load Balancers.

\n

The valid values are:

\n " } } }, "traits": { "smithy.api#documentation": "

Information about a source IP condition.

\n

You can use this condition to route based on the IP address of the source that connects to\n the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the\n IP address of the client.

\n

For Application Load Balancers, use Values to specify CIDR ranges. For\n Network Load Balancers, use IpAddressType to match on the IP address type of\n the source traffic.

" } }, "com.amazonaws.elasticloadbalancingv2#SourceNatIpv6Prefix": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SourceNatIpv6Prefixes": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SourceNatIpv6Prefix" } }, "com.amazonaws.elasticloadbalancingv2#SslPolicies": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicy" } }, "com.amazonaws.elasticloadbalancingv2#SslPolicy": { "type": "structure", "members": { "SslProtocols": { "target": "com.amazonaws.elasticloadbalancingv2#SslProtocols", "traits": { "smithy.api#documentation": "

The protocols.

" } }, "Ciphers": { "target": "com.amazonaws.elasticloadbalancingv2#Ciphers", "traits": { "smithy.api#documentation": "

The ciphers.

" } }, "Name": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

" } }, "SupportedLoadBalancerTypes": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { "smithy.api#documentation": "

The supported load balancers.

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

Information about a policy used for SSL negotiation.

" } }, "com.amazonaws.elasticloadbalancingv2#SslPolicyName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SslPolicyNames": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName" } }, "com.amazonaws.elasticloadbalancingv2#SslProtocol": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SslProtocols": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SslProtocol" } }, "com.amazonaws.elasticloadbalancingv2#StateReason": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#String": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#StringValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SubnetId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#SubnetMapping": { "type": "structure", "members": { "SubnetId": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", "traits": { "smithy.api#documentation": "

The ID of the subnet.

" } }, "AllocationId": { "target": "com.amazonaws.elasticloadbalancingv2#AllocationId", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The allocation ID of the Elastic IP address for an\n internet-facing load balancer.

" } }, "PrivateIPv4Address": { "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" } }, "IPv6Address": { "target": "com.amazonaws.elasticloadbalancingv2#IPv6Address", "traits": { "smithy.api#documentation": "

[Network Load Balancers] The IPv6 address.

" } }, "SourceNatIpv6Prefix": { "target": "com.amazonaws.elasticloadbalancingv2#SourceNatIpv6Prefix", "traits": { "smithy.api#documentation": "

[Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT.\n Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or auto_assigned \n to use an IPv6 prefix selected at random from the subnet CIDR block.

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

Information about a subnet mapping.

" } }, "com.amazonaws.elasticloadbalancingv2#SubnetMappings": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMapping" } }, "com.amazonaws.elasticloadbalancingv2#SubnetNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SubnetNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified subnet does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#Subnets": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetId" } }, "com.amazonaws.elasticloadbalancingv2#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TagKey", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#TagValue", "traits": { "smithy.api#documentation": "

The value of the tag.

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

Information about a tag.

" } }, "com.amazonaws.elasticloadbalancingv2#TagDescription": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" } }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

Information about the tags.

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

The tags associated with a resource.

" } }, "com.amazonaws.elasticloadbalancingv2#TagDescriptions": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TagDescription" } }, "com.amazonaws.elasticloadbalancingv2#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.elasticloadbalancingv2#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TagKey" } }, "com.amazonaws.elasticloadbalancingv2#TagList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#Tag" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.elasticloadbalancingv2#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideReasonEnum": { "type": "enum", "members": { "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AdministrativeOverride.Unknown" } }, "NO_OVERRIDE_ENGAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AdministrativeOverride.NoOverride" } }, "ZONAL_SHIFT_ENGAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AdministrativeOverride.ZonalShiftActive" } }, "ZONAL_SHIFT_DELEGATED_TO_DNS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AdministrativeOverride.ZonalShiftDelegatedToDns" } } } }, "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideStateEnum": { "type": "enum", "members": { "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknown" } }, "NO_OVERRIDE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "no_override" } }, "ZONAL_SHIFT_ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "zonal_shift_active" } }, "ZONAL_SHIFT_DELEGATED_TO_DNS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "zonal_shift_delegated_to_dns" } } } }, "com.amazonaws.elasticloadbalancingv2#TargetControlPort": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.elasticloadbalancingv2#TargetDescription": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elasticloadbalancingv2#TargetId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the target. If the target type of the target group is instance,\n specify an instance ID. If the target type is ip, specify an IP address. If the\n target type is lambda, specify the ARN of the Lambda function. If the target type\n is alb, specify the ARN of the Application Load Balancer target.

", "smithy.api#required": {} } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port on which the target is listening. If the target group protocol is GENEVE, the\n supported port is 6081. If the target type is alb, the targeted Application Load\n Balancer must have at least one listener whose port matches the target group port. This \n parameter is not used if the target is a Lambda function.

" } }, "AvailabilityZone": { "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", "traits": { "smithy.api#documentation": "

An Availability Zone or all. This determines whether the target receives \n traffic from the load balancer nodes in the specified Availability Zone or from all enabled \n Availability Zones for the load balancer.

\n

For Application Load Balancer target groups, the specified Availability Zone value is only applicable \n when cross-zone load balancing is off. Otherwise the parameter is ignored and treated \n as all.

\n

This parameter is not supported if the target type of the target group is\n instance or alb.

\n

If the target type is ip and the IP address is in a subnet of the VPC for the target group, \n the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside \n the VPC, this parameter is required.

\n

For Application Load Balancer target groups with cross-zone load balancing off, if the target type \n is ip and the IP address is outside of the VPC for the target group, this should be an \n Availability Zone inside the VPC for the target group.

\n

If the target type is lambda, this parameter is optional and the only\n supported value is all.

" } }, "QuicServerId": { "target": "com.amazonaws.elasticloadbalancingv2#QuicServerId", "traits": { "smithy.api#documentation": "

The server ID for the targets. This value is required if the protocol is \n QUIC or TCP_QUIC and can't be used with other protocols.

\n

The ID consists of the 0x prefix followed by 16 hexadecimal characters. \n Any letters must be lowercase. The value must be unique at the listener level. You can't \n modify the server ID for a registered target. You must deregister the target and then \n provide a new server ID when you register the target again.

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

Information about a target.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetDescriptions": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetDescription" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroup": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" } }, "TargetGroupName": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { "smithy.api#documentation": "

The name of the target group.

" } }, "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol to use for routing traffic to the targets.

" } }, "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { "smithy.api#documentation": "

The port on which the targets are listening. This parameter is not used if the target is \n a Lambda function.

" } }, "VpcId": { "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC for the targets.

" } }, "HealthCheckProtocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { "smithy.api#documentation": "

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP\n protocols are not supported for health checks.

" } }, "HealthCheckPort": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { "smithy.api#documentation": "

The port to use to connect with the target.

" } }, "HealthCheckEnabled": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { "smithy.api#documentation": "

Indicates whether health checks are enabled.

" } }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual\n target.

" } }, "HealthCheckTimeoutSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health\n check.

" } }, "HealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an unhealthy\n target healthy.

" } }, "UnhealthyThresholdCount": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy.

" } }, "HealthCheckPath": { "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { "smithy.api#documentation": "

The destination for health checks on the targets.

" } }, "Matcher": { "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { "smithy.api#documentation": "

The HTTP or gRPC codes to use when checking for a successful response from a\n target.

" } }, "LoadBalancerArns": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target\n group. You can use each target group with only one load balancer.

" } }, "TargetType": { "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", "traits": { "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target group.\n The possible values are instance (register targets by instance ID),\n ip (register targets by IP address), lambda (register a single\n Lambda function as a target), or alb (register a single Application Load Balancer\n as a target).

" } }, "ProtocolVersion": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolVersion", "traits": { "smithy.api#documentation": "

[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC,\n HTTP1, and HTTP2.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupIpAddressTypeEnum", "traits": { "smithy.api#documentation": "

The IP address type. The default value is ipv4.

" } }, "TargetControlPort": { "target": "com.amazonaws.elasticloadbalancingv2#TargetControlPort", "traits": { "smithy.api#documentation": "

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

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

Information about a target group.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TargetGroupArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupAssociationLimitException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TargetGroupAssociationLimit", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of load balancers per target group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupAttribute": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", "traits": { "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by Application Load Balancers and \n Network Load Balancers:

\n \n

The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:

\n \n

The following attribute is supported only if the load balancer is an Application Load\n Balancer and the target is a Lambda function:

\n \n

The following attributes are supported only by Network Load Balancers:

\n \n

The following attributes are supported only by Gateway Load Balancers:

\n " } }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

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

Information about a target group attribute.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9._]+$" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeValue": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttribute" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupIpAddressTypeEnum": { "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.elasticloadbalancingv2#TargetGroupList": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupTuple" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupName": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TargetGroupNames": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TargetGroupNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified target group does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessConfig": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessEnabled", "traits": { "smithy.api#documentation": "

Indicates whether target group stickiness is enabled.

" } }, "DurationSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessDurationSeconds", "traits": { "smithy.api#documentation": "

[Application Load Balancers] The time period, in seconds, during which requests from a\n client should be routed to the same target group. The range is 1-604800 seconds (7 days). You\n must specify this value when enabling target group stickiness.

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

Information about the target group stickiness for a rule.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessDurationSeconds": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessEnabled": { "type": "boolean" }, "com.amazonaws.elasticloadbalancingv2#TargetGroupTuple": { "type": "structure", "members": { "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" } }, "Weight": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupWeight", "traits": { "smithy.api#documentation": "

The weight. The range is 0 to 999.

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

Information about how traffic will be distributed between multiple target groups in a\n forward rule.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetGroupWeight": { "type": "integer" }, "com.amazonaws.elasticloadbalancingv2#TargetGroups": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroup" } }, "com.amazonaws.elasticloadbalancingv2#TargetHealth": { "type": "structure", "members": { "State": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthStateEnum", "traits": { "smithy.api#documentation": "

The state of the target.

" } }, "Reason": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthReasonEnum", "traits": { "smithy.api#documentation": "

The reason code.

\n

If the target state is healthy, a reason code is not provided.

\n

If the target state is initial, the reason code can be one of the following\n values:

\n \n

If the target state is unhealthy, the reason code can be one of the following\n values:

\n \n

If the target state is unused, the reason code can be one of the following\n values:

\n \n

If the target state is draining, the reason code can be the following\n value:

\n \n

If the target state is unavailable, the reason code can be the following\n value:

\n " } }, "Description": { "target": "com.amazonaws.elasticloadbalancingv2#Description", "traits": { "smithy.api#documentation": "

A description of the target health that provides additional details. If the state is\n healthy, a description is not provided.

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

Information about the current health of a target.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetHealthDescription": { "type": "structure", "members": { "Target": { "target": "com.amazonaws.elasticloadbalancingv2#TargetDescription", "traits": { "smithy.api#documentation": "

The description of the target.

" } }, "HealthCheckPort": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { "smithy.api#documentation": "

The port to use to connect with the target.

" } }, "TargetHealth": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealth", "traits": { "smithy.api#documentation": "

The health information for the target.

" } }, "AnomalyDetection": { "target": "com.amazonaws.elasticloadbalancingv2#AnomalyDetection", "traits": { "smithy.api#documentation": "

The anomaly detection result for the target.

\n

If no anomalies were detected, the result is normal.

\n

If anomalies were detected, the result is anomalous.

" } }, "AdministrativeOverride": { "target": "com.amazonaws.elasticloadbalancingv2#AdministrativeOverride", "traits": { "smithy.api#documentation": "

The administrative override information for the target.

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

Information about the health of a target.

" } }, "com.amazonaws.elasticloadbalancingv2#TargetHealthDescriptions": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthDescription" } }, "com.amazonaws.elasticloadbalancingv2#TargetHealthReasonEnum": { "type": "enum", "members": { "REGISTRATION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Elb.RegistrationInProgress" } }, "INITIAL_HEALTH_CHECKING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Elb.InitialHealthChecking" } }, "RESPONSE_CODE_MISMATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.ResponseCodeMismatch" } }, "TIMEOUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.Timeout" } }, "FAILED_HEALTH_CHECKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.FailedHealthChecks" } }, "NOT_REGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.NotRegistered" } }, "NOT_IN_USE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.NotInUse" } }, "DEREGISTRATION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.DeregistrationInProgress" } }, "INVALID_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.InvalidState" } }, "IP_UNUSABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.IpUnusable" } }, "HEALTH_CHECK_DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Target.HealthCheckDisabled" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Elb.InternalError" } } } }, "com.amazonaws.elasticloadbalancingv2#TargetHealthStateEnum": { "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" } }, "UNHEALTHY_DRAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unhealthy.draining" } }, "UNUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unused" } }, "DRAINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "draining" } }, "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unavailable" } } } }, "com.amazonaws.elasticloadbalancingv2#TargetId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum": { "type": "enum", "members": { "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "instance" } }, "IP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ip" } }, "LAMBDA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "lambda" } }, "ALB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "alb" } } } }, "com.amazonaws.elasticloadbalancingv2#TooManyActionsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyActions", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of actions per rule.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyCertificatesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyCertificates", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of certificates per load balancer.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyListenersException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyListeners", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of listeners per load balancer.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyLoadBalancersException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyLoadBalancers", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of load balancers for your Amazon Web Services\n account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyRegistrationsForTargetId", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of times a target can be registered with a load\n balancer.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyRulesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyRules", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of rules per load balancer.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyTagsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyTags", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of tags for this resource.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyTargetGroupsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyTargetGroups", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of target groups for your Amazon Web Services\n account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyTargets", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of targets.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyTrustStoreRevocationEntriesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyTrustStoreRevocationEntries", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified trust store has too many revocation entries.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyTrustStoresException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyTrustStores", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of trust stores for your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TooManyUniqueTargetGroupsPerLoadBalancerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TooManyUniqueTargetGroupsPerLoadBalancer", "httpResponseCode": 400 }, "smithy.api#documentation": "

You've reached the limit on the number of unique target groups per load balancer across\n all listeners. If a target group is used by multiple actions for a load balancer, it is\n counted as only one use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TotalRevokedEntries": { "type": "long" }, "com.amazonaws.elasticloadbalancingv2#TransformTypeEnum": { "type": "enum", "members": { "HOST_HEADER_REWRITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "host-header-rewrite" } }, "URL_REWRITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "url-rewrite" } } } }, "com.amazonaws.elasticloadbalancingv2#TrustStore": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreName", "traits": { "smithy.api#documentation": "

The name of the trust store.

" } }, "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

" } }, "Status": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreStatus", "traits": { "smithy.api#documentation": "

The current status of the trust store.

" } }, "NumberOfCaCertificates": { "target": "com.amazonaws.elasticloadbalancingv2#NumberOfCaCertificates", "traits": { "smithy.api#documentation": "

The number of ca certificates in the trust store.

" } }, "TotalRevokedEntries": { "target": "com.amazonaws.elasticloadbalancingv2#TotalRevokedEntries", "traits": { "smithy.api#documentation": "

The number of revoked certificates in the trust store.

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

Information about a trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TrustStoreArns": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociation": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

Information about the resources a trust store is associated with.

" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AssociationNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified association does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationResourceArn": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociationStatusEnum": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active" } }, "REMOVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "removed" } } } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociations": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreAssociation" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrustStoreInUse", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified trust store is currently in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^([a-zA-Z0-9]+-)*[a-zA-Z0-9]+$" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreNames": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreName" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrustStoreNotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified trust store does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreNotReadyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "TrustStoreNotReady", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified trust store is not active.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreRevocation": { "type": "structure", "members": { "TrustStoreArn": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trust store.

" } }, "RevocationId": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationId", "traits": { "smithy.api#documentation": "

The revocation ID of the revocation file.

" } }, "RevocationType": { "target": "com.amazonaws.elasticloadbalancingv2#RevocationType", "traits": { "smithy.api#documentation": "

The type of revocation file.

" } }, "NumberOfRevokedEntries": { "target": "com.amazonaws.elasticloadbalancingv2#NumberOfRevokedEntries", "traits": { "smithy.api#documentation": "

The number of revoked certificates.

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

Information about a revocation file in use by a trust store.

" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreRevocations": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStoreRevocation" } }, "com.amazonaws.elasticloadbalancingv2#TrustStoreStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } } } }, "com.amazonaws.elasticloadbalancingv2#TrustStores": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#TrustStore" } }, "com.amazonaws.elasticloadbalancingv2#UnsupportedProtocolException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.elasticloadbalancingv2#ErrorDescription" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UnsupportedProtocol", "httpResponseCode": 400 }, "smithy.api#documentation": "

The specified protocol is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elasticloadbalancingv2#UrlRewriteConfig": { "type": "structure", "members": { "Rewrites": { "target": "com.amazonaws.elasticloadbalancingv2#RewriteConfigList", "traits": { "smithy.api#documentation": "

The URL rewrite transform to apply to the request. The transform consists of a regular expression to match and a replacement string.

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

Information about a URL rewrite transform. This transform matches a pattern in the request URL and replaces it with the specified string.

" } }, "com.amazonaws.elasticloadbalancingv2#VpcId": { "type": "string" }, "com.amazonaws.elasticloadbalancingv2#ZonalCapacityReservationState": { "type": "structure", "members": { "State": { "target": "com.amazonaws.elasticloadbalancingv2#CapacityReservationStatus", "traits": { "smithy.api#documentation": "

The state of the capacity reservation.

" } }, "AvailabilityZone": { "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", "traits": { "smithy.api#documentation": "

Information about the Availability Zone.

" } }, "EffectiveCapacityUnits": { "target": "com.amazonaws.elasticloadbalancingv2#CapacityUnitsDouble", "traits": { "smithy.api#documentation": "

The number of effective capacity units.

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

The capacity reservation status for each Availability Zone.

" } }, "com.amazonaws.elasticloadbalancingv2#ZonalCapacityReservationStates": { "type": "list", "member": { "target": "com.amazonaws.elasticloadbalancingv2#ZonalCapacityReservationState" } }, "com.amazonaws.elasticloadbalancingv2#ZoneName": { "type": "string" } } }