Amazon Secrets Manager Secrets Manager Secret Value API

openapi: 3.2.0
info:
  title: AWS Secrets Manager Secret Value API
  version: '2017-10-17'
  description: Generated from AWS's published Smithy model for AWS Secrets Manager. 3 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://secretsmanager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Secret Value
paths:
  /#BatchGetSecretValue:
    post:
      operationId: BatchGetSecretValue
      summary: Batch Get Secret Value
      description: 'Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue. To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response. Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail. Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchGetSecretValueResponse'
              example:
                SecretValues:
                - ARN: '&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3'
                  CreatedDate: 1700591229.801
                  Name: MySecret1
                  SecretString: '{"username":"diego_ramirez","password":"EXAMPLE-PASSWORD","engine":"mysql","host":"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com","port":3306,"dbClusterIdentifier":"secretsmanagertutorial"}'
                  VersionId: a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa
                  VersionStages:
                  - AWSCURRENT
                - ARN: '&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3'
                  CreatedDate: 1699911394.105
                  Name: MySecret2
                  SecretString: '{"username":"akua_mansa","password":"EXAMPLE-PASSWORD"'
                  VersionId: a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb
                  VersionStages:
                  - AWSCURRENT
                - ARN: '&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3'
                  CreatedDate: 1699911394.105
                  Name: MySecret3
                  SecretString: '{"username":"jie_liu","password":"EXAMPLE-PASSWORD"'
                  VersionId: a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc
                  VersionStages:
                  - AWSCURRENT
                Errors: []
        '400':
          description: DecryptionFailure; InvalidNextTokenException; InvalidParameterException; InvalidRequestException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DecryptionFailure'
        '500':
          description: InternalServiceError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - secretsmanager.BatchGetSecretValue
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchGetSecretValueRequest'
            example:
              SecretIdList:
              - MySecret1
              - MySecret2
              - MySecret3
      tags:
      - Secret Value
components:
  schemas:
    DecryptionFailure:
      type: object
      properties:
        Message:
          type: string
    BatchGetSecretValueRequest:
      type: object
      properties:
        SecretIdList:
          type: array
          items:
            type: string
          description: The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
        MaxResults:
          type: integer
          description: The number of results to include in the response. If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.
        NextToken:
          type: string
          description: A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.
    Filter:
      type: object
      properties:
        Key:
          type: string
          enum:
          - description
          - name
          - tag-key
          - tag-value
          - primary-region
          - owning-service
          - all
          description: 'The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. owning-service: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.'
        Values:
          type: array
          items:
            type: string
          description: The keyword to filter for. You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
    SecretValueEntry:
      type: object
      properties:
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the secret.
        Name:
          type: string
          description: The friendly name of the secret.
        VersionId:
          type: string
          description: The unique version identifier of this version of the secret.
        SecretBinary:
          type: string
          format: byte
          description: The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
        SecretString:
          type: string
          description: The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
        VersionStages:
          type: array
          items:
            type: string
          description: A list of all of the staging labels currently attached to this version of the secret.
        CreatedDate:
          type: string
          format: date-time
          description: The date the secret was created.
    InternalServiceError:
      type: object
      properties:
        Message:
          type: string
    BatchGetSecretValueResponse:
      type: object
      properties:
        SecretValues:
          type: array
          items:
            $ref: '#/components/schemas/SecretValueEntry'
          description: A list of secret values.
        NextToken:
          type: string
          description: Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/APIErrorType'
          description: A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
    APIErrorType:
      type: object
      properties:
        SecretId:
          type: string
          description: The ARN or name of the secret.
        ErrorCode:
          type: string
          description: The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example ResourceNotFoundException,InvalidParameterException, InvalidRequestException, DecryptionFailure, or AccessDeniedException.
        Message:
          type: string
          description: A message describing the error.
  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: secretsmanager
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/secrets-manager/service/2017-10-17/secrets-manager-2017-10-17.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)