Scram Secrets - Amazon Managed Streaming for Apache Kafka

Scram Secrets

Represents a secret stored in the Amazon Secrets Manager that can be used to authenticate with a cluster using your sign-in credentials.

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 Amazon Secrets Manager service, and are used to authenticate clients using sign-in credentials.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

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.

maxResultsStringFalse

The maximum number of results to return in the response (default maximum 100 results per API call). If there are more results, the response includes a NextToken parameter.

Responses
Status codeResponse modelDescription
200 ListScramSecretsResponse

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 the 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

PATCH

Operation ID: BatchDisassociateScramSecret

Disassociates a list of SCRAM secrets from a cluster. SCRAM secrets are stored in the Amazon Secrets Manager service, and are used to authenticate clients using sign-in credentials. You can disassociate up to 10 secrets from a cluster at a time.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200 BatchDisassociateScramSecretResponse

200 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

POST

Operation ID: BatchAssociateScramSecret

Associates a list of SCRAM secrets with a cluster. SCRAM secrets are stored in the Amazon Secrets Manager service, and are used to authenticate clients using sign-in credentials. You can associate up to 10 secrets with a cluster at a time.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200 BatchAssociateScramSecretResponse

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

Schemas

Request bodies

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

Response bodies

{ "nextToken": "string", "secretArnList": [ "string" ] }
{ "clusterArn": "string", "unprocessedScramSecrets": [ { "errorCode": "string", "errorMessage": "string", "secretArn": "string" } ] }
{ "clusterArn": "string", "unprocessedScramSecrets": [ { "errorCode": "string", "errorMessage": "string", "secretArn": "string" } ] }
{ "invalidParameter": "string", "message": "string" }

Properties

BatchAssociateScramSecretRequest

Request body for BatchAssociateScramSecret.

PropertyTypeRequiredDescription
secretArnList

Array of type string

True

List of Amazon Secrets Manager secret Amazon Resource Name (ARN)s.

BatchAssociateScramSecretResponse

Response body for BatchAssociateScramSecret.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
secretArnList

Array of type string

True

List of Amazon Secrets Manager secret Amazon Resource Name (ARN)s.

BatchDisassociateScramSecretResponse

Response body for BatchDisassociateScramSecret.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ListScramSecretsResponse

Information about scram secrets associated to the cluster.

PropertyTypeRequiredDescription
nextToken

string

False

Paginated results marker.

secretArnList

Array of type string

False

The list of scram secrets associated with the cluster.

UnprocessedScramSecret

Error info for scram secret associate/disassociate failure.

PropertyTypeRequiredDescription
errorCode

string

False

Error code for associate/disassociate failure.

errorMessage

string

False

Error message for associate/disassociate failure.

secretArn

string

False

Amazon Secrets Manager secret Amazon Resource Name (ARN).

See also

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

ListScramSecrets

BatchDisassociateScramSecret

BatchAssociateScramSecret