Amazon S3 Glacier S3 Glacier Notification Configuration API

openapi: 3.1.0
info:
  title: Amazon Glacier Notification Configuration API
  version: '2012-06-01'
  description: Generated from AWS's published Smithy model for Amazon Glacier. 3 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://glacier.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /{accountId}/vaults/{vaultName}/notification-configuration:
    delete:
      operationId: DeleteVaultNotifications
      summary: Delete Vault Notifications
      description: This operation deletes the notification configuration set for a vault. The operation is eventually consistent;
        that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive
        some notifications for a short time after you send the delete request. An AWS account has full permission to perform
        all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default.
        You must grant them explicit permission to perform specific actions. For more information, see Access Control Using
        AWS Identity and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault
        Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; NoLongerSupportedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVaultNotificationsInput'
            example:
              accountId: '-'
              vaultName: examplevault
      tags:
      - Notification Configuration
    get:
      operationId: GetVaultNotifications
      summary: Get Vault Notifications
      description: This operation retrieves the notification-configuration subresource of the specified vault. For information
        about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration
        for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications,
        see Configuring Vault Notifications in Amazon Glacier. An AWS account has full permission to perform all operations
        (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must
        grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity
        and Access Management (IAM). For conceptual information and underlying REST API, see Configuring Vault Notifications
        in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVaultNotificationsOutput'
              example:
                vaultNotificationConfig:
                  Events:
                  - InventoryRetrievalCompleted
                  - ArchiveRetrievalCompleted
                  SNSTopic: arn:aws:sns:us-west-2:0123456789012:my-vault
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; NoLongerSupportedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVaultNotificationsInput'
            example:
              accountId: '-'
              vaultName: my-vault
      tags:
      - Notification Configuration
    put:
      operationId: SetVaultNotifications
      summary: Set Vault Notifications
      description: 'This operation configures notifications that will be sent when specific events happen to a vault. By default,
        you don''t get any notifications. To configure vault notifications, send a PUT request to the notification-configuration
        subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific
        events for which you want Amazon Glacier to send notifications to the topic. Amazon SNS topics must grant permission
        to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification
        for the following vault events: ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive
        retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification
        sent to the SNS topic is the same output as returned from DescribeJob. InventoryRetrievalCompleted This event occurs
        when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job
        can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
        An AWS account has full p'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; NoLongerSupportedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetVaultNotificationsInput'
            example:
              accountId: '-'
              vaultName: examplevault
              vaultNotificationConfig:
                Events:
                - ArchiveRetrievalCompleted
                - InventoryRetrievalCompleted
                SNSTopic: arn:aws:sns:us-west-2:012345678901:mytopic
      tags:
      - Notification Configuration
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: glacier
  schemas:
    DeleteVaultNotificationsInput:
      type: object
      properties:
        accountId:
          type: string
          description: The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
            an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated
            with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the
            ID.
        vaultName:
          type: string
          description: The name of the vault.
      required:
      - accountId
      - vaultName
    GetVaultNotificationsInput:
      type: object
      properties:
        accountId:
          type: string
          description: The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
            an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated
            with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the
            ID.
        vaultName:
          type: string
          description: The name of the vault.
      required:
      - accountId
      - vaultName
    GetVaultNotificationsOutput:
      type: object
      properties:
        vaultNotificationConfig:
          $ref: '#/components/schemas/VaultNotificationConfig'
    InvalidParameterValueException:
      type: object
      properties:
        type:
          type: string
          description: Client
        code:
          type: string
          description: 400 Bad Request
        message:
          type: string
          description: Returned if a parameter of the request is incorrectly specified.
    ResourceNotFoundException:
      type: object
      properties:
        type:
          type: string
          description: Client
        code:
          type: string
          description: 404 Not Found
        message:
          type: string
          description: Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
    ServiceUnavailableException:
      type: object
      properties:
        type:
          type: string
          description: Server
        code:
          type: string
          description: 500 Internal Server Error
        message:
          type: string
          description: Returned if the service cannot complete the request.
    SetVaultNotificationsInput:
      type: object
      properties:
        accountId:
          type: string
          description: The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
            an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated
            with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the
            ID.
        vaultName:
          type: string
          description: The name of the vault.
        vaultNotificationConfig:
          $ref: '#/components/schemas/VaultNotificationConfig'
      required:
      - accountId
      - vaultName
    VaultNotificationConfig:
      type: object
      properties:
        SNSTopic:
          type: string
          description: The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).
        Events:
          type: array
          items:
            type: string
          description: A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon
            SNS topic.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/glacier/service/2012-06-01/glacier-2012-06-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)