Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.DescribeChapCredentials API

openapi: 3.1.0
info:
  title: 'Amazon Storage Gateway REST Amazon Storage Gateway REST API #X Amz Target=StorageGateway 20130630.DescribeChapCredentials API'
  description: AWS Storage Gateway is a hybrid cloud storage service that gives you on-premises access to virtually unlimited cloud storage. This API enables management of gateways, volumes, virtual tapes, file shares, and cached storage resources.
  version: '2013-06-30'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://aws.amazon.com/service-terms/
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://storagegateway.{region}.amazonaws.com
  description: Amazon Storage Gateway regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
security:
- sigv4: []
tags:
- name: '#X Amz Target=StorageGateway 20130630.DescribeChapCredentials'
paths:
  /#X-Amz-Target=StorageGateway_20130630.DescribeChapCredentials:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeChapCredentials
      description: Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeChapCredentialsOutput'
        '480':
          description: InvalidGatewayRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidGatewayRequestException'
        '481':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeChapCredentialsInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StorageGateway_20130630.DescribeChapCredentials
      tags:
      - '#X Amz Target=StorageGateway 20130630.DescribeChapCredentials'
components:
  schemas:
    TargetARN:
      type: string
      minLength: 50
      maxLength: 800
    ChapSecret:
      type: string
      minLength: 1
      maxLength: 100
      format: password
    ChapInfo:
      type: object
      properties:
        TargetARN:
          allOf:
          - $ref: '#/components/schemas/TargetARN'
          - description: '<p>The Amazon Resource Name (ARN) of the volume.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>'
        SecretToAuthenticateInitiator:
          allOf:
          - $ref: '#/components/schemas/ChapSecret'
          - description: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
        InitiatorName:
          allOf:
          - $ref: '#/components/schemas/IqnName'
          - description: The iSCSI initiator that connects to the target.
        SecretToAuthenticateTarget:
          allOf:
          - $ref: '#/components/schemas/ChapSecret'
          - description: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client).
      description: Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
    InternalServerError: {}
    DescribeChapCredentialsOutput:
      type: object
      example:
        ChapCredentials:
        - InitiatorName: iqn.1991-05.com.microsoft:computername.domain.example.com
          SecretToAuthenticateInitiator: '111111111111'
          SecretToAuthenticateTarget: '222222222222'
          TargetARN: arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
      properties:
        ChapCredentials:
          allOf:
          - $ref: '#/components/schemas/ChapCredentials'
          - description: '<p>An array of <a>ChapInfo</a> objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:</p> <ul> <li> <p> <b>InitiatorName</b>: The iSCSI initiator that connects to the target.</p> </li> <li> <p> <b>SecretToAuthenticateInitiator</b>: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p> </li> <li> <p> <b>SecretToAuthenticateTarget</b>: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p> </li> <li> <p> <b>TargetARN</b>: The Amazon Resource Name (ARN) of the storage volume.</p> </li> </ul>'
      description: 'A JSON object containing the following fields:'
    ChapCredentials:
      type: array
      items:
        $ref: '#/components/schemas/ChapInfo'
    IqnName:
      type: string
      pattern: '[0-9a-z:.-]+'
      minLength: 1
      maxLength: 255
    InvalidGatewayRequestException: {}
    DescribeChapCredentialsInput:
      type: object
      required:
      - TargetARN
      title: DescribeChapCredentialsInput
      properties:
        TargetARN:
          allOf:
          - $ref: '#/components/schemas/TargetARN'
          - description: The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.
      description: A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
externalDocs:
  description: Amazon Storage Gateway API Reference
  url: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html