Scram Secrets - Amazon Managed Streaming for Apache Kafka

Scram Secrets

Represents a secret stored in AWS Secrets Manager that can be used to authenticate with a cluster using a user name and password.

URI

/v1/clusters/clusterArn/scram-secrets

HTTP Methods

GET

Operation ID: ListScramSecrets

Returns a list of SCRAM secrets associated with the cluster. SCRAM secrets are stored in the AWS Secrets Manager service, and are used to authenticate clients using usernames and passwords.

Path Parameters
Name Type Required Description
clusterArn String True

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

Query Parameters
Name Type Required Description
nextToken String False

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

maxResults String False

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Responses
Status Code Response Model Description
200 ListScramSecretsResponse

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

POST

Operation ID: BatchAssociateScramSecret

Associates a list of SCRAM secrets with a cluster. SCRAM secrets are stored in the AWS Secrets Manager service, and are used to authenticate clients using usernames and passwords.

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 BatchAssociateScramSecretResponse

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

PATCH

Operation ID: BatchDisassociateScramSecret

Disassociates a list of SCRAM secrets from a cluster. SCRAM secrets are stored in the AWS Secrets Manager service, and are used to authenticate clients using usernames and passwords.

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 BatchDisassociateScramSecretResponse

200 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

Example POST

{ "secretArnList": [ "string" ] }

Example PATCH

{ "secretArnList": [ "string" ] }

Response Bodies

Example ListScramSecretsResponse

{ "secretArnList": [ "string" ], "nextToken": "string" }

Example BatchAssociateScramSecretResponse

{ "clusterArn": "string", "unprocessedScramSecrets": [ { "secretArn": "string", "errorMessage": "string", "errorCode": "string" } ] }

Example BatchDisassociateScramSecretResponse

{ "clusterArn": "string", "unprocessedScramSecrets": [ { "secretArn": "string", "errorMessage": "string", "errorCode": "string" } ] }

Example Error

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

Properties

BatchAssociateScramSecretRequest

Request body for BatchAssociateScramSecret.

Property Type Required Description
secretArnList

Array of type string

True

List of AWS Secrets Manager secret ARNs.

BatchAssociateScramSecretResponse

Response body for BatchAssociateScramSecret.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

unprocessedScramSecrets

Array of type UnprocessedScramSecret

False

List of errors when associating secrets to cluster.

BatchDisassociateScramSecretRequest

Request body for BatchDisassociateScramSecret.

Property Type Required Description
secretArnList

Array of type string

True

List of AWS Secrets Manager secret ARNs.

BatchDisassociateScramSecretResponse

Response body for BatchDisassociateScramSecret.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

unprocessedScramSecrets

Array of type UnprocessedScramSecret

False

List of errors when disassociating secrets to cluster.

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

ListScramSecretsResponse

Information about scram secrets associated to the cluster.

Property Type Required Description
secretArnList

Array of type string

False

The list of scram secrets associated with the cluster.

nextToken

string

False

Paginated results marker.

UnprocessedScramSecret

Error info for scram secret associate/disassociate failure.

Property Type Required Description
secretArn

string

False

AWS Secrets Manager secret ARN.

errorMessage

string

False

Error message for associate/disassociate failure.

errorCode

string

False

Error code for associate/disassociate failure.

See Also

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

ListScramSecrets

BatchAssociateScramSecret

BatchDisassociateScramSecret