Amazon EKS Eks Access Policies API
The Eks Access Policies API from Amazon EKS — 3 operation(s) for eks access policies.
The Eks Access Policies API from Amazon EKS — 3 operation(s) for eks access policies.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-eks:amazon-eks-access-policies-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon Elastic Kubernetes Service Access Policies API
version: '2017-11-01'
description: Generated from AWS's published Smithy model for Amazon Elastic Kubernetes Service. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://eks.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/clusters/{clusterName}/access-entries/{principalArn}/access-policies:
post:
operationId: AssociateAccessPolicy
summary: Associate Access Policy
description: Associates an access policy and its scope to an access entry. For more information about associating access
policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateAccessPolicyResponse'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'500':
description: ServerException
content:
application/json:
schema:
$ref: '#/components/schemas/ServerException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateAccessPolicyRequest'
tags:
- Access Policies
get:
operationId: ListAssociatedAccessPolicies
summary: List Associated Access Policies
description: Lists the access policies associated with an access entry.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAssociatedAccessPoliciesResponse'
'400':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'500':
description: ServerException
content:
application/json:
schema:
$ref: '#/components/schemas/ServerException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAssociatedAccessPoliciesRequest'
tags:
- Access Policies
/clusters/{clusterName}/access-entries/{principalArn}/access-policies/{policyArn}:
delete:
operationId: DisassociateAccessPolicy
summary: Disassociate Access Policy
description: Disassociates an access policy from an access entry.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateAccessPolicyResponse'
'400':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'500':
description: ServerException
content:
application/json:
schema:
$ref: '#/components/schemas/ServerException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateAccessPolicyRequest'
tags:
- Access Policies
/access-policies:
get:
operationId: ListAccessPolicies
summary: List Access Policies
description: Lists the available access policies.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessPoliciesResponse'
'500':
description: ServerException
content:
application/json:
schema:
$ref: '#/components/schemas/ServerException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessPoliciesRequest'
tags:
- Access Policies
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: eks
schemas:
AccessPolicy:
type: object
properties:
name:
type: string
description: The name of the access policy.
arn:
type: string
description: The ARN of the access policy.
AccessScope:
type: object
properties:
type:
type: string
enum:
- cluster
- namespace
description: The scope type of an access policy.
namespaces:
type: array
items:
type: string
description: A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace
for Type.
AssociateAccessPolicyRequest:
type: object
properties:
clusterName:
type: string
description: The name of your cluster.
principalArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry that you're associating
the access policy to.
policyArn:
type: string
description: The ARN of the AccessPolicy that you're associating. For a list of ARNs, use ListAccessPolicies.
accessScope:
$ref: '#/components/schemas/AccessScope'
required:
- clusterName
- principalArn
- policyArn
- accessScope
AssociateAccessPolicyResponse:
type: object
properties:
clusterName:
type: string
description: The name of your cluster.
principalArn:
type: string
description: The ARN of the IAM principal for the AccessEntry.
associatedAccessPolicy:
$ref: '#/components/schemas/AssociatedAccessPolicy'
AssociatedAccessPolicy:
type: object
properties:
policyArn:
type: string
description: The ARN of the AccessPolicy.
accessScope:
$ref: '#/components/schemas/AccessScope'
associatedAt:
type: string
format: date-time
description: The date and time the AccessPolicy was associated with an AccessEntry.
modifiedAt:
type: string
format: date-time
description: The Unix epoch timestamp for the last modification to the object.
DisassociateAccessPolicyRequest:
type: object
properties:
clusterName:
type: string
description: The name of your cluster.
principalArn:
type: string
description: The ARN of the IAM principal for the AccessEntry.
policyArn:
type: string
description: The ARN of the policy to disassociate from the access entry. For a list of associated policies ARNs,
use ListAssociatedAccessPolicies.
required:
- clusterName
- principalArn
- policyArn
DisassociateAccessPolicyResponse:
type: object
properties: {}
InvalidParameterException:
type: object
properties:
clusterName:
type: string
description: The Amazon EKS cluster associated with the exception.
nodegroupName:
type: string
description: The Amazon EKS managed node group associated with the exception.
fargateProfileName:
type: string
description: The Fargate profile associated with the exception.
addonName:
type: string
description: The specified parameter for the add-on name is invalid. Review the available parameters for the API
request
subscriptionId:
type: string
description: The Amazon EKS subscription ID with the exception.
message:
type: string
description: The specified parameter is invalid. Review the available parameters for the API request.
InvalidRequestException:
type: object
properties:
clusterName:
type: string
description: The Amazon EKS cluster associated with the exception.
nodegroupName:
type: string
description: The Amazon EKS managed node group associated with the exception.
addonName:
type: string
description: The request is invalid given the state of the add-on name. Check the state of the cluster and the associated
operations.
subscriptionId:
type: string
description: The Amazon EKS subscription ID with the exception.
message:
type: string
description: The Amazon EKS add-on name associated with the exception.
ListAccessPoliciesRequest:
type: object
properties:
maxResults:
type: integer
description: The maximum number of results, returned in paginated output. You receive maxResults in a single page,
along with a nextToken response element. You can see the remaining results of the initial request by sending another
request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter,
100 results and a nextToken value, if applicable, are returned.
nextToken:
type: string
description: The nextToken value returned from a previous paginated request, where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. This value is null when there are no more results to return. This token should be treated
as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
purposes.
ListAccessPoliciesResponse:
type: object
properties:
accessPolicies:
type: array
items:
$ref: '#/components/schemas/AccessPolicy'
description: The list of available access policies. You can't view the contents of an access policy using the API.
To view the contents, see Access policy permissions in the Amazon EKS User Guide.
nextToken:
type: string
description: The nextToken value returned from a previous paginated request, where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. This value is null when there are no more results to return. This token should be treated
as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
purposes.
ListAssociatedAccessPoliciesRequest:
type: object
properties:
clusterName:
type: string
description: The name of your cluster.
principalArn:
type: string
description: The ARN of the IAM principal for the AccessEntry.
maxResults:
type: integer
description: The maximum number of results, returned in paginated output. You receive maxResults in a single page,
along with a nextToken response element. You can see the remaining results of the initial request by sending another
request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter,
100 results and a nextToken value, if applicable, are returned.
nextToken:
type: string
description: The nextToken value returned from a previous paginated request, where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. This value is null when there are no more results to return. This token should be treated
as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
purposes.
required:
- clusterName
- principalArn
ListAssociatedAccessPoliciesResponse:
type: object
properties:
clusterName:
type: string
description: The name of your cluster.
principalArn:
type: string
description: The ARN of the IAM principal for the AccessEntry.
nextToken:
type: string
description: The nextToken value returned from a previous paginated request, where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. This value is null when there are no more results to return. This token should be treated
as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
purposes.
associatedAccessPolicies:
type: array
items:
$ref: '#/components/schemas/AssociatedAccessPolicy'
description: The list of access policies associated with the access entry.
ResourceNotFoundException:
type: object
properties:
clusterName:
type: string
description: The Amazon EKS cluster associated with the exception.
nodegroupName:
type: string
description: The Amazon EKS managed node group associated with the exception.
fargateProfileName:
type: string
description: The Fargate profile associated with the exception.
addonName:
type: string
description: The Amazon EKS add-on name associated with the exception.
subscriptionId:
type: string
description: The Amazon EKS subscription ID with the exception.
message:
type: string
description: The Amazon EKS message associated with the exception.
ServerException:
type: object
properties:
clusterName:
type: string
description: The Amazon EKS cluster associated with the exception.
nodegroupName:
type: string
description: The Amazon EKS managed node group associated with the exception.
addonName:
type: string
description: The Amazon EKS add-on name associated with the exception.
subscriptionId:
type: string
description: The Amazon EKS subscription ID with the exception.
message:
type: string
description: These errors are usually caused by a server-side issue.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/eks/service/2017-11-01/eks-2017-11-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)