Amazon Service Catalog Portfolios API

Portfolio management operations

GitHub OpenAPI

Operations 6

POST /#CreatePortfolio Create Portfolio #
POST /#DeletePortfolio Delete Portfolio #
POST /#DescribePortfolio Describe Portfolio #
POST /#ListPortfolios List Portfolios #
POST /#ListPortfoliosForProduct List Portfolios For Product #
POST /#UpdatePortfolio Update Portfolio #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-service-catalog:amazon-service-catalog-portfolios-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-service-catalog-portfolios-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Service Catalog Portfolios API
  version: '2015-12-10'
  description: Generated from AWS's published Smithy model for AWS Service Catalog. 6 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:
  /#CreatePortfolio:
    post:
      operationId: CreatePortfolio
      summary: Create Portfolio
      description: Creates a portfolio. A delegated admin is authorized to invoke this command.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreatePortfolioOutput'
        '400':
          description: InvalidParametersException; LimitExceededException; 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.CreatePortfolio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePortfolioInput'
      tags:
      - Portfolios
  /#DeletePortfolio:
    post:
      operationId: DeletePortfolio
      summary: Delete Portfolio
      description: Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or if it has associated
        products, users, constraints, or shared accounts. A delegated admin is authorized to invoke this command.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeletePortfolioOutput'
        '400':
          description: InvalidParametersException; ResourceInUseException; 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.DeletePortfolio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeletePortfolioInput'
      tags:
      - Portfolios
  /#DescribePortfolio:
    post:
      operationId: DescribePortfolio
      summary: Describe Portfolio
      description: Gets information about the specified portfolio. A delegated admin is authorized to invoke this command.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribePortfolioOutput'
        '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.DescribePortfolio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribePortfolioInput'
      tags:
      - Portfolios
  /#ListPortfolios:
    post:
      operationId: ListPortfolios
      summary: List Portfolios
      description: Lists all portfolios in the catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPortfoliosOutput'
        '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.ListPortfolios
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPortfoliosInput'
      tags:
      - Portfolios
  /#ListPortfoliosForProduct:
    post:
      operationId: ListPortfoliosForProduct
      summary: List Portfolios For Product
      description: Lists all portfolios that the specified product is associated with.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPortfoliosForProductOutput'
        '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.ListPortfoliosForProduct
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPortfoliosForProductInput'
      tags:
      - Portfolios
  /#UpdatePortfolio:
    post:
      operationId: UpdatePortfolio
      summary: Update Portfolio
      description: Updates the specified portfolio. You cannot update a product that was shared with you.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdatePortfolioOutput'
        '400':
          description: InvalidParametersException; LimitExceededException; 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.UpdatePortfolio
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdatePortfolioInput'
      tags:
      - Portfolios
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:
    BudgetDetail:
      type: object
      properties:
        BudgetName:
          type: string
          description: Name of the associated budget.
    CreatePortfolioInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        DisplayName:
          type: string
          description: The name to use for display purposes.
        Description:
          type: string
          description: The description of the portfolio.
        ProviderName:
          type: string
          description: The name of the portfolio provider.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags.
        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:
      - DisplayName
      - ProviderName
      - IdempotencyToken
    CreatePortfolioOutput:
      type: object
      properties:
        PortfolioDetail:
          $ref: '#/components/schemas/PortfolioDetail'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Information about the tags associated with the portfolio.
    DeletePortfolioInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The portfolio identifier.
      required:
      - Id
    DeletePortfolioOutput:
      type: object
      properties: {}
    DescribePortfolioInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The portfolio identifier.
      required:
      - Id
    DescribePortfolioOutput:
      type: object
      properties:
        PortfolioDetail:
          $ref: '#/components/schemas/PortfolioDetail'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Information about the tags associated with the portfolio.
        TagOptions:
          type: array
          items:
            $ref: '#/components/schemas/TagOptionDetail'
          description: Information about the TagOptions associated with the portfolio.
        Budgets:
          type: array
          items:
            $ref: '#/components/schemas/BudgetDetail'
          description: Information about the associated budgets.
    InvalidParametersException:
      type: object
      properties:
        Message:
          type: string
    ListPortfoliosForProductInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        ProductId:
          type: string
          description: The product identifier.
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
      required:
      - ProductId
    ListPortfoliosForProductOutput:
      type: object
      properties:
        PortfolioDetails:
          type: array
          items:
            $ref: '#/components/schemas/PortfolioDetail'
          description: Information about the portfolios.
        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.
    ListPortfoliosInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        PageToken:
          type: string
          description: The page token for the next set of results. To retrieve the first set of results, use null.
        PageSize:
          type: integer
          description: The maximum number of items to return with this call.
    ListPortfoliosOutput:
      type: object
      properties:
        PortfolioDetails:
          type: array
          items:
            $ref: '#/components/schemas/PortfolioDetail'
          description: Information about the portfolios.
        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.
    PortfolioDetail:
      type: object
      properties:
        Id:
          type: string
          description: The portfolio identifier.
        ARN:
          type: string
          description: The ARN assigned to the portfolio.
        DisplayName:
          type: string
          description: The name to use for display purposes.
        Description:
          type: string
          description: The description of the portfolio.
        CreatedTime:
          type: string
          format: date-time
          description: The UTC time stamp of the creation time.
        ProviderName:
          type: string
          description: The name of the portfolio provider.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key.
        Value:
          type: string
          description: The value for this key.
      required:
      - Key
      - Value
    TagOptionDetail:
      type: object
      properties:
        Key:
          type: string
          description: The TagOption key.
        Value:
          type: string
          description: The TagOption value.
        Active:
          type: boolean
          description: The TagOption active state.
        Id:
          type: string
          description: The TagOption identifier.
        Owner:
          type: string
          description: The Amazon Web Services account Id of the owner account that created the TagOption.
    UpdatePortfolioInput:
      type: object
      properties:
        AcceptLanguage:
          type: string
          description: The language code. jp - Japanese zh - Chinese
        Id:
          type: string
          description: The portfolio identifier.
        DisplayName:
          type: string
          description: The name to use for display purposes.
        Description:
          type: string
          description: The updated description of the portfolio.
        ProviderName:
          type: string
          description: The updated name of the portfolio provider.
        AddTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to add.
        RemoveTags:
          type: array
          items:
            type: string
          description: The tags to remove.
      required:
      - Id
    UpdatePortfolioOutput:
      type: object
      properties:
        PortfolioDetail:
          $ref: '#/components/schemas/PortfolioDetail'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Information about the tags associated with the portfolio.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)