AWS Glue AWS Glue #X Amz Target=AWSGlue.ListSessions API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.ListSessions API'
  version: '2017-03-31'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged AWS Glue #X Amz Target=AWSGlue.ListSessions API across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-listsessions-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-listsessions-api-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: https://glue.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.ListSessions API'
paths:
  /#X-Amz-Target=AWSGlue.ListSessions:
    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: ListSessions
      description: Retrieve a list of sessions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSessionsResponse'
              examples:
                ListSessions200Example:
                  summary: Default ListSessions 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                ListSessions480Example:
                  summary: Default ListSessions 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ListSessions481Example:
                  summary: Default ListSessions 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                ListSessions482Example:
                  summary: Default ListSessions 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '483':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                ListSessions483Example:
                  summary: Default ListSessions 483 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSessionsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.ListSessions
      summary: Amazon Glue List Sessions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.ListSessions API'
      security:
      - hmac: []
    servers:
    - url: http://glue.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The AWS Glue multi-region endpoint
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The AWS Glue multi-region endpoint
    - url: http://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
    - url: https://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
  /#ListSessions:
    post:
      operationId: post#ListSessions
      summary: List Sessions
      description: Retrieve a list of sessions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListSessionsResponse_2'
        '400':
          description: AccessDeniedException; InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.ListSessions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListSessionsRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.ListSessions API'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: ListSessions
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    OrchestrationArgumentsValue:
      type: string
      minLength: 0
      maxLength: 4096
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    InvalidInputException: {}
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    SessionList:
      type: array
      items:
        $ref: '#/components/schemas/Session'
    ListSessionsRequest:
      type: object
      title: ListSessionsRequest
      properties:
        NextToken:
          allOf:
          - $ref: '#/components/schemas/OrchestrationToken'
          - description: 'The token for the next set of results, or null if there are no more result. '
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/PageSize'
          - description: 'The maximum number of results. '
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagsMap'
          - description: 'Tags belonging to the session. '
        RequestOrigin:
          allOf:
          - $ref: '#/components/schemas/OrchestrationNameString'
          - description: 'The origin of the request. '
    ConnectionsList:
      type: object
      properties:
        Connections:
          allOf:
          - $ref: '#/components/schemas/OrchestrationStringList'
          - description: A list of connections used by the job.
      description: Specifies the connections used by a job.
    PageSize:
      type: integer
      minimum: 1
      maximum: 1000
    PythonVersionString:
      type: string
      pattern: ^([2-3]|3[.]9)$
    ListSessionsResponse:
      type: object
      properties:
        Ids:
          allOf:
          - $ref: '#/components/schemas/SessionIdList'
          - description: 'Returns the ID of the session. '
        Sessions:
          allOf:
          - $ref: '#/components/schemas/SessionList'
          - description: 'Returns the session object. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/OrchestrationToken'
          - description: 'The token for the next set of results, or null if there are no more result. '
    OrchestrationToken:
      type: string
      maxLength: 400000
    DescriptionString:
      type: string
      minLength: 0
      maxLength: 2048
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    OrchestrationRoleArn:
      type: string
      pattern: arn:aws[^:]*:iam::[0-9]*:role/.+
      minLength: 20
      maxLength: 2048
    OrchestrationArgumentsMap:
      type: object
      minProperties: 0
      maxProperties: 75
      additionalProperties:
        $ref: '#/components/schemas/OrchestrationArgumentsValue'
    SessionStatus:
      type: string
      enum:
      - PROVISIONING
      - READY
      - FAILED
      - TIMEOUT
      - STOPPING
      - STOPPED
    OrchestrationStringList:
      type: array
      items:
        $ref: '#/components/schemas/GenericString'
    SessionCommand:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
        PythonVersion:
          allOf:
          - $ref: '#/components/schemas/PythonVersionString'
          - description: Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
      description: The <code>SessionCommand</code> that runs the job.
    GenericString:
      type: string
    GlueVersionString:
      type: string
      pattern: ^\w+\.\w+$
      minLength: 1
      maxLength: 255
    SessionIdList:
      type: array
      items:
        $ref: '#/components/schemas/NameString'
    OrchestrationNameString:
      type: string
      pattern: '[\.\-_A-Za-z0-9]+'
      minLength: 1
      maxLength: 128
    DoubleValue:
      type: number
      format: double
    TimestampValue:
      type: string
      format: date-time
    TagsMap:
      type: object
      minProperties: 0
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    AccessDeniedException: {}
    InternalServiceException: {}
    NullableDouble:
      type: number
      format: double
    Session:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The ID of the session.
        CreatedOn:
          allOf:
          - $ref: '#/components/schemas/TimestampValue'
          - description: The time and date when the session was created.
        Status:
          allOf:
          - $ref: '#/components/schemas/SessionStatus'
          - description: 'The session status. '
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: The error message displayed during the session.
        Description:
          allOf:
          - $ref: '#/components/schemas/DescriptionString'
          - description: The description of the session.
        Role:
          allOf:
          - $ref: '#/components/schemas/OrchestrationRoleArn'
          - description: The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
        Command:
          allOf:
          - $ref: '#/components/schemas/SessionCommand'
          - description: The command object.See SessionCommand.
        DefaultArguments:
          allOf:
          - $ref: '#/components/schemas/OrchestrationArgumentsMap'
          - description: 'A map array of key-value pairs. Max is 75 pairs. '
        Connections:
          allOf:
          - $ref: '#/components/schemas/ConnectionsList'
          - description: The number of connections used for the session.
        Progress:
          allOf:
          - $ref: '#/components/schemas/DoubleValue'
          - description: The code execution progress of the session.
        MaxCapacity:
          allOf:
          - $ref: '#/components/schemas/NullableDouble'
          - description: 'The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory. '
        SecurityConfiguration:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The name of the SecurityConfiguration structure to be used with the session.
        GlueVersion:
          allOf:
          - $ref: '#/components/schemas/GlueVersionString'
          - description: The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
      description: The period in which a remote Spark runtime environment is running.
    OperationTimeoutException: {}
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    ListSessionsResponse_2:
      type: object
      properties:
        Ids:
          type: array
          items:
            type: string
          description: Returns the ID of the session.
        Sessions:
          type: array
          items:
            $ref: '#/components/schemas/Session_2'
          description: Returns the session object.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more result.
    AccessDeniedException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    ListSessionsRequest_2:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more result.
        MaxResults:
          type: integer
          description: The maximum number of results.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Tags belonging to the session.
        RequestOrigin:
          type: string
          description: The origin of the request.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    ConnectionsList_2:
      type: object
      properties:
        Connections:
          type: array
          items:
            type: string
          description: A list of connections used by the job.
    Session_2:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the session.
        CreatedOn:
          type: string
          format: date-time
          description: The time and date when the session was created.
        Status:
          type: string
          enum:
          - PROVISIONING
          - READY
          - FAILED
          - TIMEOUT
          - STOPPING
          - STOPPED
          description: The session status.
        ErrorMessage:
          type: string
          description: The error message displayed during the session.
        Description:
          type: string
          description: The description of the session.
        Role:
          type: string
          description: The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
        Command:
          $ref: '#/components/schemas/SessionCommand_2'
        DefaultArguments:
          type: object
          additionalProperties:
            type: string
          description: A map array of key-value pairs. Max is 75 pairs.
        Connections:
          $ref: '#/components/schemas/ConnectionsList_2'
        Progress:
          type: number
          description: The code execution progress of the session.
        MaxCapacity:
          type: number
          description: The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
        SecurityConfiguration:
          type: string
          description: The name of the SecurityConfiguration structure to be used with the session.
        GlueVersion:
          type: string
          description: The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
        NumberOfWorkers:
          type: integer
          description: The number of workers of a defined WorkerType to use for the session.
        WorkerType:
          type: string
          enum:
          - Standard
          - G.1X
          - G.2X
          - G.4X
          - G.8X
          - G.025X
          - Z.2X
          - G.12X
          - G.16X
          - R.1X
          - R.2X
          - R.4X
          - R.8X
          description: The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, or R.8X for Spark sessions. Accepts the value Z.2X for Ray sessions. The G.12X, G.16X, and R.1X through R.8X worker types are available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.
        CompletedOn:
          type: string
          format: date-time
          description: The date and time that this session is completed.
        ExecutionTime:
          type: number
          description: The total time the session ran for.
        DPUSeconds:
          type: number
          description: 'The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).'
        IdleTimeout:
          type: integer
          description: The number of minutes when idle before the session times out.
        ProfileName:
          type: string
          description: The name of an Glue usage profile associated with the session.
        SessionType:
          type: string
          enum:
          - LIVY
          - SPARK_CONNECT
          description: The type of the session.
    SessionCommand_2:
      type: object
      properties:
        Name:
          type: string
          description: Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
        PythonVersion:
          type: string
          description: Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    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: glue
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-refined-from:
- amazon-glue-x-amz-target-awsglue-listsessions-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-listsessions-api-api-openapi.yml
x-hasEquivalentPaths: true