ServiceSpecificCredential
Contains the details of a service-specific credential.
Contents
- CreateDate
-
The date and time, in ISO 8601 date-time format
, when the service-specific credential were created. Type: Timestamp
Required: Yes
- ServiceName
-
The name of the service associated with the service-specific credential.
Type: String
Required: Yes
- ServiceSpecificCredentialId
-
The unique identifier for the service-specific credential.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 128.
Pattern:
[\w]+
Required: Yes
- Status
-
The status of the service-specific credential.
Active
means that the key is valid for API calls, whileInactive
means it is not.Type: String
Valid Values:
Active | Inactive | Expired
Required: Yes
- UserName
-
The name of the IAM user associated with the service-specific credential.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w+=,.@-]+
Required: Yes
- ExpirationDate
-
The date and time when the service specific credential expires. This field is only present for Bedrock API keys that were created with an expiration period.
Type: Timestamp
Required: No
- ServiceCredentialAlias
-
For Bedrock API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Pattern:
[\w+=,.@-]+
Required: No
- ServiceCredentialSecret
-
For Bedrock API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.
Type: String
Required: No
- ServicePassword
-
The generated password for the service-specific credential.
Type: String
Required: No
- ServiceUserName
-
The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon account, as in
jane-at-123456789012
, for example. This value cannot be configured by the user.Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Pattern:
[\w+=,.@-]*
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: