Amazon Simple Workflow Service #X Amz Target=SimpleWorkflowService.DescribeActivityType API

openapi: 3.2.0
info:
  version: '2012-01-25'
  x-release: v4
  title: 'Amazon Simple Workflow Service #X Amz…'
  description: 'Amazon Simple Workflow Service

    The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon''s cloud to coordinate work across distributed components.'
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: swf
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/swf-2012-01-25.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://swf.{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 Amazon SWF multi-region endpoint
- url: https://swf.{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 Amazon SWF multi-region endpoint
- url: http://swf.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon SWF endpoint for China (Beijing) and China (Ningxia)
- url: https://swf.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon SWF endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=SimpleWorkflowService.DescribeActivityType'
paths:
  /#X-Amz-Target=SimpleWorkflowService.DescribeActivityType:
    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: DescribeActivityType
      description: 'Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.


        Access Control


        You can use IAM policies to control this action''s access to Amazon SWF resources as follows:


        Use a Resource element with the domain name to limit the action to only specified domains.


        Use an Action element to allow or deny permission to call this action.


        Constrain the following parameters by using a Condition element with the appropriate keys.


        activityType.name: String constraint. The key is swf:activityType.name.


        activityType.version: String constraint. The key is swf:activityType.version.


        If the caller doesn''t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute''s cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityTypeDetail'
        '480':
          description: UnknownResourceFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnknownResourceFault'
        '481':
          description: OperationNotPermittedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedFault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeActivityTypeInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SimpleWorkflowService.DescribeActivityType
        example: SimpleWorkflowService.DescribeActivityType
      summary: Amazon SWF Describe Activity Type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=SimpleWorkflowService.DescribeActivityType'
components:
  schemas:
    UnknownResourceFault: {}
    OperationNotPermittedFault: {}
    TaskPriority:
      type: string
    ActivityTypeConfiguration:
      type: object
      properties:
        defaultTaskStartToCloseTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSecondsOptional'
          - description: <p> The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
        defaultTaskHeartbeatTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSecondsOptional'
          - description: <p> The default maximum time, in seconds, before which a worker processing a task must report progress by calling <a>RecordActivityTaskHeartbeat</a>.</p> <p>You can specify this value only when <i>registering</i> an activity type. The registered default value can be overridden when you schedule a task through the <code>ScheduleActivityTask</code> <a>Decision</a>. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an <code>UnknownResource</code> fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
        defaultTaskList:
          allOf:
          - $ref: '#/components/schemas/TaskList'
          - description: ' The default task list specified for this activity type at registration. This default is used if a task list isn''t provided when a task is scheduled through the <code>ScheduleActivityTask</code> <a>Decision</a>. You can override the default registered task list when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.'
        defaultTaskPriority:
          allOf:
          - $ref: '#/components/schemas/TaskPriority'
          - description: <p> The default task priority for tasks of this activity type, specified at registration. If not set, then <code>0</code> is used as the default priority. This default can be overridden when scheduling an activity task.</p> <p>Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>
        defaultTaskScheduleToStartTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSecondsOptional'
          - description: <p> The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
        defaultTaskScheduleToCloseTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSecondsOptional'
          - description: <p> The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
      description: Configuration settings registered with the activity type.
    ActivityType:
      type: object
      required:
      - name
      - version
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: <p>The name of this activity.</p> <note> <p>The combination of activity type name and version must be unique within a domain.</p> </note>
        version:
          allOf:
          - $ref: '#/components/schemas/Version'
          - description: <p>The version of this activity.</p> <note> <p>The combination of activity type name and version must be unique with in a domain.</p> </note>
      description: Represents an activity type.
    Description:
      type: string
      maxLength: 1024
    RegistrationStatus:
      type: string
      enum:
      - REGISTERED
      - DEPRECATED
    ActivityTypeInfo:
      type: object
      required:
      - activityType
      - status
      - creationDate
      properties:
        activityType:
          allOf:
          - $ref: '#/components/schemas/ActivityType'
          - description: The <a>ActivityType</a> type structure representing the activity type.
        status:
          allOf:
          - $ref: '#/components/schemas/RegistrationStatus'
          - description: The current status of the activity type.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The description of the activity type provided in <a>RegisterActivityType</a>.
        creationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time this activity type was created through <a>RegisterActivityType</a>.
        deprecationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: If DEPRECATED, the date and time <a>DeprecateActivityType</a> was called.
      description: Detailed information about an activity type.
    Name:
      type: string
      minLength: 1
      maxLength: 256
    TaskList:
      type: object
      required:
      - name
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the task list.
      description: Represents a task list.
    DescribeActivityTypeInput:
      type: object
      required:
      - domain
      - activityType
      title: DescribeActivityTypeInput
      properties:
        domain:
          allOf:
          - $ref: '#/components/schemas/DomainName'
          - description: The name of the domain in which the activity type is registered.
        activityType:
          allOf:
          - $ref: '#/components/schemas/ActivityType'
          - description: The activity type to get information about. Activity types are identified by the <code>name</code> and <code>version</code> that were supplied when the activity was registered.
    DomainName:
      type: string
      minLength: 1
      maxLength: 256
    ActivityTypeDetail:
      type: object
      required:
      - typeInfo
      - configuration
      properties:
        typeInfo:
          allOf:
          - $ref: '#/components/schemas/ActivityTypeInfo'
          - description: <p>General information about the activity type.</p> <p>The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.</p> <ul> <li> <p> <code>REGISTERED</code> – The type is registered and available. Workers supporting this type should be running. </p> </li> <li> <p> <code>DEPRECATED</code> – The type was deprecated using <a>DeprecateActivityType</a>, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type. </p> </li> </ul>
        configuration:
          allOf:
          - $ref: '#/components/schemas/ActivityTypeConfiguration'
          - description: The configuration settings registered with the activity type.
      description: Detailed information about an activity type.
    DurationInSecondsOptional:
      type: string
      maxLength: 8
    Version:
      type: string
      minLength: 1
      maxLength: 64
    Timestamp:
      type: string
      format: date-time
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      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
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/swf/
x-hasEquivalentPaths: true