Clusters clusterArn Policy - Amazon Managed Streaming for Apache Kafka

Clusters clusterArn Policy

URI

/v1/clusters/clusterArn/policy

HTTP methods

GET

Operation ID: GetClusterPolicy

Get cluster policy.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200 GetClusterPolicyResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

PUT

Operation ID: PutClusterPolicy

Create or update cluster policy.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200 PutClusterPolicyResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

DELETE

Operation ID: DeleteClusterPolicy

Delete cluster policy.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200 DeleteClusterPolicyResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

OPTIONS

Enable CORS by returning correct headers.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Request bodies

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

Response bodies

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

Properties

DeleteClusterPolicyResponse

Delete resource policy for MSK cluster

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

GetClusterPolicyResponse

Returns resource policy for MSK cluster

PropertyTypeRequiredDescription
currentVersion

string

False

Resource policy version

policy

string

False

Resource policy attached to the MSK cluster

PutClusterPolicyRequest

Create or update resource policy for cluster

PropertyTypeRequiredDescription
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

PropertyTypeRequiredDescription
currentVersion

string

False

Resource policy version

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetClusterPolicy

PutClusterPolicy

DeleteClusterPolicy