Amazon Service Catalog Service Catalog Service Action API

openapi: 3.1.0
info:
  title: AWS Service Catalog Service Action API
  version: '2015-12-10'
  description: Generated from AWS's published Smithy model for AWS Service Catalog. 10 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://servicecatalog.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#AssociateServiceActionWithProvisioningArtifact:
    post:
      operationId: AssociateServiceActionWithProvisioningArtifact
      summary: Associate Service Action With Provisioning Artifact
      description: Associates a self-service action with a provisioning artifact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AssociateServiceActionWithProvisioningArtifactOutput'
        '400':
          description: DuplicateResourceException; InvalidParametersException; LimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.AssociateServiceActionWithProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/AssociateServiceActionWithProvisioningArtifactInput'
      tags:
      - Service Action
  /#BatchAssociateServiceActionWithProvisioningArtifact:
    post:
      operationId: BatchAssociateServiceActionWithProvisioningArtifact
      summary: Batch Associate Service Action With Provisioning Artifact
      description: Associates multiple self-service actions with provisioning artifacts.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchAssociateServiceActionWithProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.BatchAssociateServiceActionWithProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchAssociateServiceActionWithProvisioningArtifactInput'
      tags:
      - Service Action
  /#BatchDisassociateServiceActionFromProvisioningArtifact:
    post:
      operationId: BatchDisassociateServiceActionFromProvisioningArtifact
      summary: Batch Disassociate Service Action From Provisioning Artifact
      description: Disassociates a batch of self-service actions from the specified provisioning artifact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BatchDisassociateServiceActionFromProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.BatchDisassociateServiceActionFromProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/BatchDisassociateServiceActionFromProvisioningArtifactInput'
      tags:
      - Service Action
  /#CreateServiceAction:
    post:
      operationId: CreateServiceAction
      summary: Create Service Action
      description: Creates a self-service action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateServiceActionOutput'
        '400':
          description: InvalidParametersException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.CreateServiceAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateServiceActionInput'
      tags:
      - Service Action
  /#DeleteServiceAction:
    post:
      operationId: DeleteServiceAction
      summary: Delete Service Action
      description: Deletes a self-service action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteServiceActionOutput'
        '400':
          description: InvalidParametersException; ResourceInUseException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DeleteServiceAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteServiceActionInput'
      tags:
      - Service Action
  /#DescribeServiceAction:
    post:
      operationId: DescribeServiceAction
      summary: Describe Service Action
      description: Describes a self-service action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeServiceActionOutput'
        '400':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DescribeServiceAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeServiceActionInput'
      tags:
      - Service Action
  /#DisassociateServiceActionFromProvisioningArtifact:
    post:
      operationId: DisassociateServiceActionFromProvisioningArtifact
      summary: Disassociate Service Action From Provisioning Artifact
      description: Disassociates the specified self-service action association from the specified provisioning artifact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisassociateServiceActionFromProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.DisassociateServiceActionFromProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisassociateServiceActionFromProvisioningArtifactInput'
      tags:
      - Service Action
  /#ListServiceActions:
    post:
      operationId: ListServiceActions
      summary: List Service Actions
      description: Lists all self-service actions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListServiceActionsOutput'
        '400':
          description: InvalidParametersException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.ListServiceActions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListServiceActionsInput'
      tags:
      - Service Action
  /#ListServiceActionsForProvisioningArtifact:
    post:
      operationId: ListServiceActionsForProvisioningArtifact
      summary: List Service Actions For Provisioning Artifact
      description: Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning
        Artifact ID.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListServiceActionsForProvisioningArtifactOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.ListServiceActionsForProvisioningArtifact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListServiceActionsForProvisioningArtifactInput'
      tags:
      - Service Action
  /#UpdateServiceAction:
    post:
      operationId: UpdateServiceAction
      summary: Update Service Action
      description: Updates a self-service action.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateServiceActionOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParametersException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWS242ServiceCatalogService.UpdateServiceAction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateServiceActionInput'
      tags:
      - Service Action
components:
  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: servicecatalog
  schemas:
    AssociateServiceActionWithProvisioningArtifactInput:
      type: object
      properties:
        ProductId:
          type: string
          description: The product identifier. For example, prod-abcdzk7xy33qa.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
        ServiceActionId:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        IdempotencyToken:
          type: string
          description: A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon
            Web Services account use the same idempotency token, the same response is returned for each repeated request.
      required:
      - ProductId
      - ProvisioningArtifactId
      - ServiceActionId
    AssociateServiceActionWithProvisioningArtifactOutput:
      type: object
      properties: {}
    BatchAssociateServiceActionWithProvisioningArtifactInput:
      type: object
      properties:
        ServiceActionAssociations:
          type: array
          items:
            $ref: '#/components/schemas/ServiceActionAssociation'
          description: One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact
            ID.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - ServiceActionAssociations
    BatchAssociateServiceActionWithProvisioningArtifactOutput:
      type: object
      properties:
        FailedServiceActionAssociations:
          type: array
          items:
            $ref: '#/components/schemas/FailedServiceActionAssociation'
          description: An object that contains a list of errors, along with information to help you identify the self-service
            action.
    BatchDisassociateServiceActionFromProvisioningArtifactInput:
      type: object
      properties:
        ServiceActionAssociations:
          type: array
          items:
            $ref: '#/components/schemas/ServiceActionAssociation'
          description: One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact
            ID.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - ServiceActionAssociations
    BatchDisassociateServiceActionFromProvisioningArtifactOutput:
      type: object
      properties:
        FailedServiceActionAssociations:
          type: array
          items:
            $ref: '#/components/schemas/FailedServiceActionAssociation'
          description: An object that contains a list of errors, along with information to help you identify the self-service
            action.
    CreateServiceActionInput:
      type: object
      properties:
        Name:
          type: string
          description: The self-service action name.
        DefinitionType:
          type: string
          enum:
          - SSM_AUTOMATION
          description: The service action definition type. For example, SSM_AUTOMATION.
        Definition:
          type: object
          additionalProperties:
            type: string
          description: 'The self-service action definition. Can be one of the following: Name The name of the Amazon Web Services
            Systems Manager document (SSM document). For example, AWS-RestartEC2Instance. If you are using a shared SSM document,
            you must provide the ARN instead of the name. Version The Amazon Web Services Systems Manager automation document
            version. For example, "Version": "1" AssumeRole The Amazon Resource Name (ARN) of the role that performs the self-service
            actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole". To reuse the provisioned
            product launch role,'
        Description:
          type: string
          description: The self-service action description.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        IdempotencyToken:
          type: string
          description: A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the
            idempotency token, the same response is returned for each repeated request.
      required:
      - Name
      - DefinitionType
      - Definition
      - IdempotencyToken
    CreateServiceActionOutput:
      type: object
      properties:
        ServiceActionDetail:
          $ref: '#/components/schemas/ServiceActionDetail'
    DeleteServiceActionInput:
      type: object
      properties:
        Id:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        IdempotencyToken:
          type: string
          description: A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon
            Web Services account use the same idempotency token, the same response is returned for each repeated request.
      required:
      - Id
    DeleteServiceActionOutput:
      type: object
      properties: {}
    DescribeServiceActionInput:
      type: object
      properties:
        Id:
          type: string
          description: The self-service action identifier.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - Id
    DescribeServiceActionOutput:
      type: object
      properties:
        ServiceActionDetail:
          $ref: '#/components/schemas/ServiceActionDetail'
    DisassociateServiceActionFromProvisioningArtifactInput:
      type: object
      properties:
        ProductId:
          type: string
          description: The product identifier. For example, prod-abcdzk7xy33qa.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
        ServiceActionId:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        IdempotencyToken:
          type: string
          description: A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon
            Web Services account use the same idempotency token, the same response is returned for each repeated request.
      required:
      - ProductId
      - ProvisioningArtifactId
      - ServiceActionId
    DisassociateServiceActionFromProvisioningArtifactOutput:
      type: object
      properties: {}
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    FailedServiceActionAssociation:
      type: object
      properties:
        ServiceActionId:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        ProductId:
          type: string
          description: The product identifier. For example, prod-abcdzk7xy33qa.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
        ErrorCode:
          type: string
          enum:
          - DUPLICATE_RESOURCE
          - INTERNAL_FAILURE
          - LIMIT_EXCEEDED
          - RESOURCE_NOT_FOUND
          - THROTTLING
          - INVALID_PARAMETER
          description: The error code. Valid values are listed below.
        ErrorMessage:
          type: string
          description: A text description of the error.
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListServiceActionsForProvisioningArtifactInput:
      type: object
      properties:
        ProductId:
          type: string
          description: The product identifier. For example, prod-abcdzk7xy33qa.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - ProductId
      - ProvisioningArtifactId
    ListServiceActionsForProvisioningArtifactOutput:
      type: object
      properties:
        ServiceActionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ServiceActionSummary'
          description: An object containing information about the self-service actions associated with the provisioning artifact.
        NextPageToken:
          type: string
          description: The page token to use to retrieve the next set of results. If there are no additional results, this
            value is null.
    ListServiceActionsInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
    ListServiceActionsOutput:
      type: object
      properties:
        ServiceActionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ServiceActionSummary'
          description: An object containing information about the service actions associated with the provisioning artifact.
        NextPageToken:
          type: string
          description: The page token to use to retrieve the next set of results. If there are no additional results, this
            value is null.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceActionAssociation:
      type: object
      properties:
        ServiceActionId:
          type: string
          description: The self-service action identifier. For example, act-fs7abcd89wxyz.
        ProductId:
          type: string
          description: The product identifier. For example, prod-abcdzk7xy33qa.
        ProvisioningArtifactId:
          type: string
          description: The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
      required:
      - ServiceActionId
      - ProductId
      - ProvisioningArtifactId
    ServiceActionDetail:
      type: object
      properties:
        ServiceActionSummary:
          $ref: '#/components/schemas/ServiceActionSummary'
        Definition:
          type: object
          additionalProperties:
            type: string
          description: A map that defines the self-service action.
    ServiceActionSummary:
      type: object
      properties:
        Id:
          type: string
          description: The self-service action identifier.
        Name:
          type: string
          description: The self-service action name.
        Description:
          type: string
          description: The self-service action description.
        DefinitionType:
          type: string
          enum:
          - SSM_AUTOMATION
          description: The self-service action definition type. For example, SSM_AUTOMATION.
    UpdateServiceActionInput:
      type: object
      properties:
        Id:
          type: string
          description: The self-service action identifier.
        Name:
          type: string
          description: The self-service action name.
        Definition:
          type: object
          additionalProperties:
            type: string
          description: A map that defines the self-service action.
        Description:
          type: string
          description: The self-service action description.
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
      required:
      - Id
    UpdateServiceActionOutput:
      type: object
      properties:
        ServiceActionDetail:
          $ref: '#/components/schemas/ServiceActionDetail'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)