Amazon Service Catalog Service Catalog Resources API

openapi: 3.1.0
info:
  title: AWS Service Catalog Resources API
  version: '2015-12-10'
  description: Generated from AWS's published Smithy model for AWS Service Catalog. 5 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-appregistry.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#ListResourcesForTagOption:
    post:
      operationId: ListResourcesForTagOption
      summary: List Resources For Tag Option
      description: Lists the resources associated with the specified TagOption.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListResourcesForTagOptionOutput'
        '400':
          description: InvalidParametersException; ResourceNotFoundException; TagOptionNotMigratedException
          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.ListResourcesForTagOption
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListResourcesForTagOptionInput'
      tags:
      - Resources
      servers:
      - url: https://servicecatalog.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /applications/{application}/resources/{resourceType}/{resource}:
    put:
      operationId: AssociateResource
      summary: Associate Resource
      description: Associates a resource with an application. The resource can be specified by its ARN or name. The application
        can be specified by ARN, ID, or name. Minimum permissions You must have the following permissions to associate a resource
        using the OPTIONS parameter set to APPLY_APPLICATION_TAG. tag:GetResources tag:TagResources You must also have these
        additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see
        AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide. resource-groups:AssociateResource cloudformation:UpdateStack
        cloudformation:DescribeStacks In addition, you must have the tagging permission defined by the Amazon Web Services
        service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateResourceResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicecatalogAppregistryResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateResourceRequest'
      tags:
      - Resources
    delete:
      operationId: DisassociateResource
      summary: Disassociate Resource
      description: Disassociates a resource from application. Both the resource and the application can be specified either
        by ID or name. Minimum permissions You must have the following permissions to remove a resource that's been associated
        with an application using the APPLY_APPLICATION_TAG option for AssociateResource. tag:GetResources tag:UntagResources
        You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For
        more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide. resource-groups:DisassociateResource
        cloudformation:UpdateStack cloudformation:DescribeStacks In addition, you must have the tagging permission defined
        by the Amazon Web Services service that creates the resource. For more information, see UntagResources in the Resource
        Groups Tagging API Reference.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateResourceResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicecatalogAppregistryResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisassociateResourceRequest'
      tags:
      - Resources
    get:
      operationId: GetAssociatedResource
      summary: Get Associated Resource
      description: Gets the resource associated with the application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssociatedResourceResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicecatalogAppregistryResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAssociatedResourceRequest'
      tags:
      - Resources
  /applications/{application}/resources:
    get:
      operationId: ListAssociatedResources
      summary: List Associated Resources
      description: Lists all of the resources that are associated with the specified application. Results are paginated. If
        you share an application, and a consumer account associates a tag query to the application, all of the users who can
        access the application can also view the tag values in all accounts that are associated with it using this API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssociatedResourcesResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicecatalogAppregistryResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssociatedResourcesRequest'
      tags:
      - Resources
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:
    ApplicationTagResult:
      type: object
      properties:
        applicationTagStatus:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILURE
          description: The application tag is in the process of being applied to a resource, was successfully applied to a
            resource, or failed to apply to a resource.
        errorMessage:
          type: string
          description: The message returned if the call fails.
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourcesListItem'
          description: The resources associated with an application
        nextToken:
          type: string
          description: A unique pagination token for each page of results. Make the call again with the returned token to
            retrieve the next page of results.
    AssociateResourceRequest:
      type: object
      properties:
        application:
          type: string
          description: The name, ID, or ARN of the application.
        resourceType:
          type: string
          enum:
          - CFN_STACK
          - RESOURCE_TAG_VALUE
          description: The type of resource of which the application will be associated.
        resource:
          type: string
          description: The name or ID of the resource of which the application will be associated.
        options:
          type: array
          items:
            type: string
            enum:
            - APPLY_APPLICATION_TAG
            - SKIP_APPLICATION_TAG
          description: Determines whether an application tag is applied or skipped.
      required:
      - application
      - resourceType
      - resource
    AssociateResourceResponse:
      type: object
      properties:
        applicationArn:
          type: string
          description: The Amazon resource name (ARN) of the application that was augmented with attributes.
        resourceArn:
          type: string
          description: The Amazon resource name (ARN) that specifies the resource.
        options:
          type: array
          items:
            type: string
            enum:
            - APPLY_APPLICATION_TAG
            - SKIP_APPLICATION_TAG
          description: Determines whether an application tag is applied or skipped.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    DisassociateResourceRequest:
      type: object
      properties:
        application:
          type: string
          description: The name or ID of the application.
        resourceType:
          type: string
          enum:
          - CFN_STACK
          - RESOURCE_TAG_VALUE
          description: The type of the resource that is being disassociated.
        resource:
          type: string
          description: The name or ID of the resource.
      required:
      - application
      - resourceType
      - resource
    DisassociateResourceResponse:
      type: object
      properties:
        applicationArn:
          type: string
          description: The Amazon resource name (ARN) that specifies the application.
        resourceArn:
          type: string
          description: The Amazon resource name (ARN) that specifies the resource.
    GetAssociatedResourceRequest:
      type: object
      properties:
        application:
          type: string
          description: The name, ID, or ARN of the application.
        resourceType:
          type: string
          enum:
          - CFN_STACK
          - RESOURCE_TAG_VALUE
          description: The type of resource associated with the application.
        resource:
          type: string
          description: The name or ID of the resource associated with the application.
        nextToken:
          type: string
          description: A unique pagination token for each page of results. Make the call again with the returned token to
            retrieve the next page of results.
        resourceTagStatus:
          type: array
          items:
            type: string
            enum:
            - SUCCESS
            - FAILED
            - IN_PROGRESS
            - SKIPPED
          description: States whether an application tag is applied, not applied, in the process of being applied, or skipped.
        maxResults:
          type: integer
          description: The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value
            is optional.
      required:
      - application
      - resourceType
      - resource
    GetAssociatedResourceResponse:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/Resource'
        options:
          type: array
          items:
            type: string
            enum:
            - APPLY_APPLICATION_TAG
            - SKIP_APPLICATION_TAG
          description: Determines whether an application tag is applied or skipped.
        applicationTagResult:
          $ref: '#/components/schemas/ApplicationTagResult'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListAssociatedResourcesRequest:
      type: object
      properties:
        application:
          type: string
          description: The name, ID, or ARN of the application.
        nextToken:
          type: string
          description: The token to use to get the next page of results after a previous API call.
        maxResults:
          type: integer
          description: The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted,
            it defaults to 25. This value is optional.
      required:
      - application
    ListAssociatedResourcesResponse:
      type: object
      properties:
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceInfo'
          description: Information about the resources.
        nextToken:
          type: string
          description: The token to use to get the next page of results after a previous API call.
    ListResourcesForTagOptionInput:
      type: object
      properties:
        TagOptionId:
          type: string
          description: The TagOption identifier.
        ResourceType:
          type: string
          description: The resource type. Portfolio Product
        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.
      required:
      - TagOptionId
    ListResourcesForTagOptionOutput:
      type: object
      properties:
        ResourceDetails:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDetail'
          description: Information about the resources.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
    Resource:
      type: object
      properties:
        name:
          type: string
          description: The name of the resource.
        arn:
          type: string
          description: The Amazon resource name (ARN) of the resource.
        associationTime:
          type: string
          format: date-time
          description: The time the resource was associated with the application.
        integrations:
          $ref: '#/components/schemas/ResourceIntegrations'
    ResourceDetail:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the resource.
        ARN:
          type: string
          description: The ARN of the resource.
        Name:
          type: string
          description: The name of the resource.
        Description:
          type: string
          description: The description of the resource.
        CreatedTime:
          type: string
          format: date-time
          description: The creation time of the resource.
    ResourceDetails:
      type: object
      properties:
        tagValue:
          type: string
          description: The value of the tag.
    ResourceGroup:
      type: object
      properties:
        state:
          type: string
          enum:
          - CREATING
          - CREATE_COMPLETE
          - CREATE_FAILED
          - UPDATING
          - UPDATE_COMPLETE
          - UPDATE_FAILED
          description: 'The state of the propagation process for the resource group. The states includes: CREATING if the
            resource group is in the process of being created. CREATE_COMPLETE if the resource group was created successfully.
            CREATE_FAILED if the resource group failed to be created. UPDATING if the resource group is in the process of
            being updated. UPDATE_COMPLETE if the resource group updated successfully. UPDATE_FAILED if the resource group
            could not update successfully.'
        arn:
          type: string
          description: The Amazon resource name (ARN) of the resource group.
        errorMessage:
          type: string
          description: The error message that generates when the propagation process for the resource group fails.
    ResourceInfo:
      type: object
      properties:
        name:
          type: string
          description: The name of the resource.
        arn:
          type: string
          description: The Amazon resource name (ARN) that specifies the resource across services.
        resourceType:
          type: string
          enum:
          - CFN_STACK
          - RESOURCE_TAG_VALUE
          description: Provides information about the Service Catalog App Registry resource type.
        resourceDetails:
          $ref: '#/components/schemas/ResourceDetails'
        options:
          type: array
          items:
            type: string
            enum:
            - APPLY_APPLICATION_TAG
            - SKIP_APPLICATION_TAG
          description: Determines whether an application tag is applied or skipped.
    ResourceIntegrations:
      type: object
      properties:
        resourceGroup:
          $ref: '#/components/schemas/ResourceGroup'
    ResourcesListItem:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon resource name (ARN) of the resource.
        errorMessage:
          type: string
          description: The message returned if the call fails.
        status:
          type: string
          description: The status of the list item.
        resourceType:
          type: string
          description: Provides information about the AppRegistry resource type.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ServicecatalogAppregistryResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: A message associated with the Throttling exception.
        serviceCode:
          type: string
          description: The originating service code.
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json