Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateApiKeyCredentialProvider

Creates a new API key credential provider.

Request Syntax


POST /identities/CreateApiKeyCredentialProvider HTTP/1.1
Content-type: application/json

{
   "apiKey": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

apiKey

The API key to use for authentication. This value is encrypted and stored securely.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65536.

Required: Yes

name

The name of the API key credential provider. The name must be unique within your account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9\-_]+

Required: Yes

tags

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9\s._:/=+@-]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9\s._:/=+@-]*

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "apiKeySecretArn": { 
      "secretArn": "string"
   },
   "credentialProviderArn": "string",
   "name": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

apiKeySecretArn

The Amazon Resource Name (ARN) of the secret containing the API key.

Type: Secret object

credentialProviderArn

The Amazon Resource Name (ARN) of the created API key credential provider.

Type: String

Pattern: arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+

name

The name of the created API key credential provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9\-_]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

DecryptionFailure

Exception thrown when decryption of a secret fails.

HTTP Status Code: 400

EncryptionFailure

Exception thrown when encryption of a secret fails.

HTTP Status Code: 400

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceLimitExceededException

Exception thrown when a resource limit is exceeded.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

UnauthorizedException

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400