Amazon IAM Iam Service Specific Credential API

openapi: 3.2.0
info:
  title: AWS Identity and Access Management Service Specific…
  version: '2010-05-08'
  description: Generated from AWS's published Smithy model for AWS Identity and Access Management. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iam.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Service Specific Credential
paths:
  /?Action=CreateServiceSpecificCredential:
    post:
      operationId: CreateServiceSpecificCredential
      summary: Create Service Specific Credential
      description: 'Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. You can have a maximum of two sets of service-specific credentials for each supported service per user. You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateServiceSpecificCredentialResponse'
        '409':
          description: LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NoSuchEntityException; ServiceNotSupportedException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateServiceSpecificCredential
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/CreateServiceSpecificCredentialRequest'
      tags:
      - Service Specific Credential
  /?Action=DeleteServiceSpecificCredential:
    post:
      operationId: DeleteServiceSpecificCredential
      summary: Delete Service Specific Credential
      description: Deletes the specified service-specific credential.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteServiceSpecificCredential
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/DeleteServiceSpecificCredentialRequest'
      tags:
      - Service Specific Credential
  /?Action=ListServiceSpecificCredentials:
    post:
      operationId: ListServiceSpecificCredentials
      summary: List Service Specific Credentials
      description: 'Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs: For service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide. For service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with Amazon Keyspaces (for Apache Cassandra) in the IAM User Guide. For services that support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListServiceSpecificCredentialsResponse'
        '404':
          description: NoSuchEntityException; ServiceNotSupportedException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListServiceSpecificCredentials
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/ListServiceSpecificCredentialsRequest'
      tags:
      - Service Specific Credential
  /?Action=ResetServiceSpecificCredential:
    post:
      operationId: ResetServiceSpecificCredential
      summary: Reset Service Specific Credential
      description: Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ResetServiceSpecificCredential
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/ResetServiceSpecificCredentialRequest'
      tags:
      - Service Specific Credential
  /?Action=UpdateServiceSpecificCredential:
    post:
      operationId: UpdateServiceSpecificCredential
      summary: Update Service Specific Credential
      description: 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.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateServiceSpecificCredential
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/UpdateServiceSpecificCredentialRequest'
      tags:
      - Service Specific Credential
components:
  schemas:
    UpdateServiceSpecificCredentialRequest:
      type: object
      properties:
        UserName:
          type: string
          description: '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: _+=,.@-'
        ServiceSpecificCredentialId:
          type: string
          description: 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:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status to be assigned to the service-specific credential.
      required:
      - ServiceSpecificCredentialId
      - Status
    NoSuchEntityException:
      type: object
      properties:
        message:
          type: string
    ListServiceSpecificCredentialsRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the user whose service-specific credentials you want information about. If this value is not specified, 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: _+=,.@-'
        ServiceName:
          type: string
          description: Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services.
        AllUsers:
          type: boolean
          description: A flag indicating whether to list service specific credentials for all users. This parameter cannot be specified together with UserName. When true, returns all credentials associated with the specified service.
        Marker:
          type: string
          description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker from the response that you received to indicate where the next call should start.
        MaxItems:
          type: integer
          description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
    ServiceSpecificCredential:
      type: object
      properties:
        CreateDate:
          type: string
          format: date-time
          description: The date and time, in ISO 8601 date-time format, when the service-specific credential were created.
        ExpirationDate:
          type: string
          format: date-time
          description: The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.
        ServiceName:
          type: string
          description: The name of the service associated with the service-specific credential.
        ServiceUserName:
          type: string
          description: 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 Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.
        ServicePassword:
          type: string
          description: The generated password for the service-specific credential.
        ServiceCredentialAlias:
          type: string
          description: For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.
        ServiceCredentialSecret:
          type: string
          description: For Bedrock API keys and CloudWatch Logs 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.
        ServiceSpecificCredentialId:
          type: string
          description: The unique identifier for the service-specific credential.
        UserName:
          type: string
          description: The name of the IAM user associated with the service-specific credential.
        Status:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.
      required:
      - CreateDate
      - ServiceName
      - ServiceSpecificCredentialId
      - UserName
      - Status
    ResetServiceSpecificCredentialRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, 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: _+=,.@-'
        ServiceSpecificCredentialId:
          type: string
          description: 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.
      required:
      - ServiceSpecificCredentialId
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    ListServiceSpecificCredentialsResponse:
      type: object
      properties:
        ServiceSpecificCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ServiceSpecificCredentialMetadata'
          description: A list of structures that each contain details about a service-specific credential.
        Marker:
          type: string
          description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.
    CreateServiceSpecificCredentialRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service. 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: _+=,.@-'
        ServiceName:
          type: string
          description: The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.
        CredentialAgeDays:
          type: integer
          description: The number of days until the service specific credential expires. This field is only valid for services that support long-term API keys and must be a positive integer. When not specified, the credential will not expire. To see which services support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.
      required:
      - UserName
      - ServiceName
    ServiceSpecificCredentialMetadata:
      type: object
      properties:
        UserName:
          type: string
          description: The name of the IAM user associated with the service-specific credential.
        Status:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.
        ServiceUserName:
          type: string
          description: The generated user name for the service-specific credential.
        ServiceCredentialAlias:
          type: string
          description: For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.
        CreateDate:
          type: string
          format: date-time
          description: The date and time, in ISO 8601 date-time format, when the service-specific credential were created.
        ExpirationDate:
          type: string
          format: date-time
          description: The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.
        ServiceSpecificCredentialId:
          type: string
          description: The unique identifier for the service-specific credential.
        ServiceName:
          type: string
          description: The name of the service associated with the service-specific credential.
      required:
      - UserName
      - Status
      - CreateDate
      - ServiceSpecificCredentialId
      - ServiceName
    ResetServiceSpecificCredentialResponse:
      type: object
      properties:
        ServiceSpecificCredential:
          $ref: '#/components/schemas/ServiceSpecificCredential'
    DeleteServiceSpecificCredentialRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, 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: _+=,.@-'
        ServiceSpecificCredentialId:
          type: string
          description: The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
      required:
      - ServiceSpecificCredentialId
    CreateServiceSpecificCredentialResponse:
      type: object
      properties:
        ServiceSpecificCredential:
          $ref: '#/components/schemas/ServiceSpecificCredential'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iam
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iam/service/2010-05-08/iam-2010-05-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)