{ "smithy": "2.0", "shapes": { "com.amazonaws.eksauth#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.eksauth#AssumeRoleForPodIdentity": { "type": "operation", "input": { "target": "com.amazonaws.eksauth#AssumeRoleForPodIdentityRequest" }, "output": { "target": "com.amazonaws.eksauth#AssumeRoleForPodIdentityResponse" }, "errors": [ { "target": "com.amazonaws.eksauth#AccessDeniedException" }, { "target": "com.amazonaws.eksauth#ExpiredTokenException" }, { "target": "com.amazonaws.eksauth#InternalServerException" }, { "target": "com.amazonaws.eksauth#InvalidParameterException" }, { "target": "com.amazonaws.eksauth#InvalidRequestException" }, { "target": "com.amazonaws.eksauth#InvalidTokenException" }, { "target": "com.amazonaws.eksauth#ResourceNotFoundException" }, { "target": "com.amazonaws.eksauth#ServiceUnavailableException" }, { "target": "com.amazonaws.eksauth#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/clusters/{clusterName}/assume-role-for-pod-identity" } } }, "com.amazonaws.eksauth#AssumeRoleForPodIdentityRequest": { "type": "structure", "members": { "clusterName": { "target": "com.amazonaws.eksauth#ClusterName", "traits": { "smithy.api#documentation": "

The name of the cluster for the request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "token": { "target": "com.amazonaws.eksauth#JwtToken", "traits": { "smithy.api#documentation": "

The token of the Kubernetes service account for the pod.

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

The Kubernetes node name of the worker node where the pod is running.

" } }, "instanceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon EC2 instance ID of the worker node where the pod is running.

" } }, "zone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Availability Zone ID of the worker node where the pod is running.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.eksauth#AssumeRoleForPodIdentityResponse": { "type": "structure", "members": { "subject": { "target": "com.amazonaws.eksauth#Subject", "traits": { "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

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

The identity that is allowed to use the credentials. This value is always pods.eks.amazonaws.com.

", "smithy.api#required": {} } }, "podIdentityAssociation": { "target": "com.amazonaws.eksauth#PodIdentityAssociation", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) and ID of the EKS Pod Identity association.

", "smithy.api#required": {} } }, "assumedRoleUser": { "target": "com.amazonaws.eksauth#AssumedRoleUser", "traits": { "smithy.api#documentation": "

An object with the permanent IAM role identity and the temporary session name.

The ARN of the IAM role that the temporary credentials authenticate to.

The session name of the temporary session requested to STS. The value is a unique identifier that contains the role ID, a colon (:), and the role session name of the role that is being assumed. The role ID is generated by IAM when the role is created. The role session name part of the value follows this format: eks-clustername-podname-random UUID

", "smithy.api#required": {} } }, "credentials": { "target": "com.amazonaws.eksauth#Credentials", "traits": { "smithy.api#documentation": "

The Amazon Web Services Signature Version 4 type of temporary credentials.

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

The ARN of the workload identity provider for the returned credentials. Returned only for associations with workload identity enabled.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.eksauth#AssumedRoleUser": { "type": "structure", "members": { "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that the temporary credentials authenticate to.

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

The session name of the temporary session requested to STS. The value is a unique identifier that contains the role ID, a colon (:), and the role session name of the role that is being assumed. The role ID is generated by IAM when the role is created. The role session name part of the value follows this format: eks-clustername-podname-random UUID

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

An object with the permanent IAM role identity and the temporary session name.

" } }, "com.amazonaws.eksauth#ClusterName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" } }, "com.amazonaws.eksauth#Credentials": { "type": "structure", "members": { "sessionToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token that applications inside the pods must pass to any service API to use the temporary credentials.

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

The secret access key that applications inside the pods use to sign requests.

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

The access key ID that identifies the temporary security credentials.

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

The Unix epoch timestamp in seconds when the current credentials expire.

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

The Amazon Web Services Signature Version 4 type of temporary credentials.

", "smithy.api#sensitive": {} } }, "com.amazonaws.eksauth#EKSAuthFrontend": { "type": "service", "version": "2023-11-26", "operations": [ { "target": "com.amazonaws.eksauth#AssumeRoleForPodIdentity" } ], "traits": { "aws.api#service": { "sdkId": "EKS Auth", "arnNamespace": "eks-auth", "endpointPrefix": "eks-auth" }, "aws.auth#sigv4": { "name": "eks-auth" }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

", "smithy.api#title": "Amazon EKS Auth", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://eks-auth-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://eks-auth.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://eks-auth-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://eks-auth.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 9, "nodes": "/////wAAAAH/////AAAAAAAAAAkAAAADAAAAAQAAAAQF9eEIAAAAAgAAAAUF9eEIAAAAAwAAAAcAAAAGAAAABQX14QUF9eEHAAAABAAAAAgF9eEEAAAABQX14QMF9eEGAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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": [], "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": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://eks-auth-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://eks-auth.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://eks-auth-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": [], "endpoint": { "url": "https://eks-auth.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://eks-auth.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": 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, "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, "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, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.eksauth#ExpiredTokenException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The specified Kubernetes service account token is expired.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.eksauth#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

These errors are usually caused by a server-side issue.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.eksauth#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.eksauth#InvalidRequestException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.eksauth#InvalidTokenException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The specified Kubernetes service account token is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.eksauth#JwtToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+\\.[A-Za-z0-9-_=]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.eksauth#PodIdentityAssociation": { "type": "structure", "members": { "associationArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EKS Pod Identity association.

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

The ID of the association.

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

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

" } }, "com.amazonaws.eksauth#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The specified resource could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.eksauth#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The service is unavailable. Back off and retry the operation.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.eksauth#Subject": { "type": "structure", "members": { "namespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.

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

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

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

An object containing the name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

" } }, "com.amazonaws.eksauth#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The request was denied because your request rate is too high. Reduce the frequency of requests.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } } } }