update_service_specific_credential¶
Operation¶
update_service_specific_credential
¶
update_service_specific_credential(request: UpdateServiceSpecificCredentialInput | UpdateServiceSpecificCredentialInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateServiceSpecificCredentialInputDict]) -> UpdateServiceSpecificCredentialOutput
Sets the status of a service-specific credential to Active or
Inactive. Service-specific credentials that are inactive cannot be
used for authentication to the service. This operation can be used to
disable a user's service-specific credential as part of a credential
rotation work flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateServiceSpecificCredentialInput | UpdateServiceSpecificCredentialInputDict | 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[UpdateServiceSpecificCredentialInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateServiceSpecificCredentialOutput
|
An instance of |
update_service_specific_credential
async
¶
update_service_specific_credential(request: UpdateServiceSpecificCredentialInput | UpdateServiceSpecificCredentialInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateServiceSpecificCredentialInputDict]) -> UpdateServiceSpecificCredentialOutput
Sets the status of a service-specific credential to Active or
Inactive. Service-specific credentials that are inactive cannot be
used for authentication to the service. This operation can be used to
disable a user's service-specific credential as part of a credential
rotation work flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateServiceSpecificCredentialInput | UpdateServiceSpecificCredentialInputDict | 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[UpdateServiceSpecificCredentialInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateServiceSpecificCredentialOutput
|
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.
UpdateServiceSpecificCredentialInputDict
¶
Bases: TypedDict
Dictionary form of UpdateServiceSpecificCredentialInput.
Attributes¶
service_specific_credential_id
instance-attribute
¶
The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
status
instance-attribute
¶
The status to be assigned to the service-specific credential.
user_name
instance-attribute
¶
user_name: str | None
The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
UpdateServiceSpecificCredentialInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateServiceSpecificCredentialInput structure.
Attributes¶
service_specific_credential_id
class-attribute
instance-attribute
¶
service_specific_credential_id: str | None = ...
The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The status to be assigned to the service-specific credential.
user_name
class-attribute
instance-attribute
¶
user_name: str | None = ...
The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
UpdateServiceSpecificCredentialOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateServiceSpecificCredentialOutput structure.