create_api_key_credential_provider¶
Operation¶
create_api_key_credential_provider
¶
create_api_key_credential_provider(request: CreateApiKeyCredentialProviderInput | CreateApiKeyCredentialProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateApiKeyCredentialProviderInputDict]) -> CreateApiKeyCredentialProviderOutput
Creates a new API key credential provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateApiKeyCredentialProviderInput | CreateApiKeyCredentialProviderInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateApiKeyCredentialProviderInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateApiKeyCredentialProviderOutput
|
An instance of |
create_api_key_credential_provider
async
¶
create_api_key_credential_provider(request: CreateApiKeyCredentialProviderInput | CreateApiKeyCredentialProviderInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateApiKeyCredentialProviderInputDict]) -> CreateApiKeyCredentialProviderOutput
Creates a new API key credential provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateApiKeyCredentialProviderInput | CreateApiKeyCredentialProviderInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateApiKeyCredentialProviderInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateApiKeyCredentialProviderOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateApiKeyCredentialProviderInputDict
¶
Bases: TypedDict
Dictionary form of CreateApiKeyCredentialProviderInput.
Attributes¶
api_key
instance-attribute
¶
api_key: str | None
The API key to use for authentication. This value is encrypted and stored securely.
api_key_secret_config
instance-attribute
¶
api_key_secret_config: SecretReference | SecretReferenceDict | None
A reference to the Amazon Web Services Secrets Manager secret that
stores the API key. This includes the secret ID and the JSON key used to
extract the API key value from the secret. Required when
apiKeySecretSource is set to EXTERNAL.
api_key_secret_source
instance-attribute
¶
api_key_secret_source: str | None
The source type of the API key secret. Use MANAGED if the secret is
managed by the service, or EXTERNAL if you manage the secret yourself
in Amazon Web Services Secrets Manager.
name
instance-attribute
¶
The name of the API key credential provider. The name must be unique within your account.
CreateApiKeyCredentialProviderInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateApiKeyCredentialProviderInput structure.
Attributes¶
api_key
class-attribute
instance-attribute
¶
api_key: str = ...
The API key to use for authentication. This value is encrypted and stored securely.
api_key_secret_config
class-attribute
instance-attribute
¶
api_key_secret_config: SecretReference | None = ...
A reference to the Amazon Web Services Secrets Manager secret that
stores the API key. This includes the secret ID and the JSON key used to
extract the API key value from the secret. Required when
apiKeySecretSource is set to EXTERNAL.
api_key_secret_source
class-attribute
instance-attribute
¶
api_key_secret_source: str | None = ...
The source type of the API key secret. Use MANAGED if the secret is
managed by the service, or EXTERNAL if you manage the secret yourself
in Amazon Web Services Secrets Manager.
Output¶
CreateApiKeyCredentialProviderOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateApiKeyCredentialProviderOutput structure.
Attributes¶
api_key_secret_arn
instance-attribute
¶
api_key_secret_arn: Secret
The Amazon Resource Name (ARN) of the secret containing the API key.
api_key_secret_json_key
class-attribute
instance-attribute
¶
api_key_secret_json_key: str | None = ...
The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
api_key_secret_source
class-attribute
instance-attribute
¶
api_key_secret_source: str | None = ...
The source type of the API key secret. Either MANAGED if the secret is
managed by the service, or EXTERNAL if managed by the user in Amazon
Web Services Secrets Manager.
credential_provider_arn
instance-attribute
¶
credential_provider_arn: str
The Amazon Resource Name (ARN) of the created API key credential provider.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.