URI HTTP methods Schemas Properties See also

Clusters clusterArn Policy

URI

/v1/clusters/clusterArn/policy

HTTP methods

DELETE

Operation ID: DeleteClusterPolicy

Delete cluster policy.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code	Response model	Description
`200`	`DeleteClusterPolicyResponse`	Successful response.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

GET

Operation ID: GetClusterPolicy

Get cluster policy.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code	Response model	Description
`200`	`GetClusterPolicyResponse`	Successful response.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

OPTIONS

Enable CORS by returning correct headers.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

PUT

Operation ID: PutClusterPolicy

Create or update cluster policy.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code	Response model	Description
`200`	`PutClusterPolicyResponse`	Successful response.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

Schemas

Request bodies


{
  "currentVersion": "string",
  "policy": "string"
}

Response bodies

{
}


{
  "currentVersion": "string",
  "policy": "string"
}


{
  "currentVersion": "string"
}


{
  "invalidParameter": "string",
  "message": "string"
}

Properties

DeleteClusterPolicyResponse

Delete resource policy for MSK cluster

Error

Returns information about an error.

Property	Type	Required	Description
`invalidParameter`	string	False	The parameter that caused the error.
`message`	string	False	The description of the error.

GetClusterPolicyResponse

Returns resource policy for MSK cluster

Property	Type	Required	Description
`currentVersion`	string	False	Resource policy version
`policy`	string	False	Resource policy attached to the MSK cluster

PutClusterPolicyRequest

Create or update resource policy for cluster

Property Type Required Description

Property	Type	Required	Description
`currentVersion`	string MinLength: 1	False	Current cluster policy version.
`policy`	string MinLength: 1 MaxLength: 20480	True	Resource policy for cluster

currentVersion

string

MinLength: 1

False

Current cluster policy version.

policy

string

MinLength: 1

MaxLength: 20480

True

Resource policy for cluster

PutClusterPolicyResponse

Create or update cluster policy

Property	Type	Required	Description
`currentVersion`	string	False	Resource policy version