Amazon Systems Manager Systems Manager Extensions API

openapi: 3.1.0
info:
  title: Amazon Simple Systems Manager (SSM) Extensions API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 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://appconfig.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /extensions:
    post:
      operationId: CreateExtension
      summary: Create Extension
      description: Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different
        points during the AppConfig workflow of creating or deploying a configuration. You can create your own extensions
        or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda,
        you must create a Lambda function to perform any computation and processing defined in the extension. If you plan
        to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an
        Amazon Resource Name (ARN) in the Uri field for the new extension version. For a custom EventBridge notification extension,
        enter the ARN of the EventBridge default events in the Uri field. For a custom Amazon SNS notification extension,
        enter the ARN of an Amazon SNS topic in the Uri field. For a custom Amazon SQS notification extension, enter the ARN
        of an Amazon SQS message queue in the Uri field. For more information about extensions, see Extending workflows in
        the AppConfig User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExtensionRequest'
      tags:
      - Extensions
    get:
      operationId: ListExtensions
      summary: List Extensions
      description: Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information
        about extensions, see Extending workflows in the AppConfig User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extensions'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListExtensionsRequest'
      tags:
      - Extensions
  /extensions/{ExtensionIdentifier}:
    delete:
      operationId: DeleteExtension
      summary: Delete Extension
      description: Deletes an AppConfig extension. You must delete all associations to an extension before you delete the
        extension.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteExtensionRequest'
      tags:
      - Extensions
    get:
      operationId: GetExtension
      summary: Get Extension
      description: Returns information about an AppConfig extension.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetExtensionRequest'
      tags:
      - Extensions
    patch:
      operationId: UpdateExtension
      summary: Update Extension
      description: Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig
        User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExtensionRequest'
      tags:
      - Extensions
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: appconfig
  schemas:
    Action:
      type: object
      properties:
        Name:
          type: string
          description: The action name.
        Description:
          type: string
          description: Information about the action.
        Uri:
          type: string
          description: 'The extension URI associated to the action point in the extension definition. The URI can be an Amazon
            Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon
            Simple Notification Service topic, or the Amazon EventBridge default event bus.'
        RoleArn:
          type: string
          description: An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
    AppconfigInternalServerException:
      type: object
      properties:
        Message:
          type: string
    AppconfigParameter:
      type: object
      properties:
        Description:
          type: string
          description: Information about the parameter.
        Required:
          type: boolean
          description: A parameter value must be specified in the extension association.
        Dynamic:
          type: boolean
          description: Indicates whether this parameter's value can be supplied at the extension's action point instead of
            during extension association. Dynamic parameters can't be marked Required.
    AppconfigResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceName:
          type: string
    AppconfigServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    BadRequestDetails:
      type: object
      properties:
        InvalidConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/InvalidConfigurationDetail'
          description: Detailed information about the bad request exception error when creating a hosted configuration version.
      description: Exactly one member is set.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - InvalidConfiguration
        Details:
          $ref: '#/components/schemas/BadRequestDetails'
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateExtensionRequest:
      type: object
      properties:
        Name:
          type: string
          description: A name for the extension. Each extension name in your account must be unique. Extension versions use
            the same name.
        Description:
          type: string
          description: Information about the extension.
        Actions:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Action'
          description: The actions defined in the extension.
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppconfigParameter'
          description: The parameters accepted by the extension. You specify parameter values when you associate the extension
            to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these
            parameters are included in the Lambda request object.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources
            in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional
            value, both of which you define.
        LatestVersionNumber:
          type: integer
          description: You can omit this field when you create an extension. When you create a new version, specify the most
            recent current version number. For example, you create version 3, enter 2 for this field.
      required:
      - Name
      - Actions
    DeleteExtensionRequest:
      type: object
      properties:
        ExtensionIdentifier:
          type: string
          description: The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
        VersionNumber:
          type: integer
          description: A specific version of an extension to delete. If omitted, the highest version is deleted.
      required:
      - ExtensionIdentifier
    Extension:
      type: object
      properties:
        Id:
          type: string
          description: The system-generated ID of the extension.
        Name:
          type: string
          description: The extension name.
        VersionNumber:
          type: integer
          description: The extension version number.
        Arn:
          type: string
          description: The system-generated Amazon Resource Name (ARN) for the extension.
        Description:
          type: string
          description: Information about the extension.
        Actions:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Action'
          description: The actions defined in the extension.
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppconfigParameter'
          description: The parameters accepted by the extension. You specify parameter values when you associate the extension
            to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these
            parameters are included in the Lambda request object.
    ExtensionSummary:
      type: object
      properties:
        Id:
          type: string
          description: The system-generated ID of the extension.
        Name:
          type: string
          description: The extension name.
        VersionNumber:
          type: integer
          description: The extension version number.
        Arn:
          type: string
          description: The system-generated Amazon Resource Name (ARN) for the extension.
        Description:
          type: string
          description: Information about the extension.
    Extensions:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionSummary'
          description: The list of available extensions. The list includes Amazon Web Services authored and user-created extensions.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    GetExtensionRequest:
      type: object
      properties:
        ExtensionIdentifier:
          type: string
          description: The name, the ID, or the Amazon Resource Name (ARN) of the extension.
        VersionNumber:
          type: integer
          description: The extension version number. If no version number was defined, AppConfig uses the highest version.
      required:
      - ExtensionIdentifier
    InvalidConfigurationDetail:
      type: object
      properties:
        Constraint:
          type: string
          description: The invalid or out-of-range validation constraint in your JSON schema that failed validation.
        Location:
          type: string
          description: Location of the validation constraint in the configuration JSON schema that failed validation.
        Reason:
          type: string
          description: The reason for an invalid configuration error.
        Type:
          type: string
          description: The type of error for an invalid configuration.
        Value:
          type: string
          description: Details about an error with Lambda when a synchronous extension experiences an error during an invocation.
    ListExtensionsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify
            in a subsequent call to get the next set of results.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
        Name:
          type: string
          description: The extension name.
    UpdateExtensionRequest:
      type: object
      properties:
        ExtensionIdentifier:
          type: string
          description: The name, the ID, or the Amazon Resource Name (ARN) of the extension.
        Description:
          type: string
          description: Information about the extension.
        Actions:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Action'
          description: The actions defined in the extension.
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppconfigParameter'
          description: One or more parameters for the actions called by the extension.
        VersionNumber:
          type: integer
          description: The extension version number.
      required:
      - ExtensionIdentifier
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appconfig/service/2019-10-09/appconfig-2019-10-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)