Amazon Connect Connect Email Addresses API

openapi: 3.1.0
info:
  title: Amazon Connect Service Email Addresses API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /email-addresses/{InstanceId}:
    put:
      operationId: CreateEmailAddress
      summary: Create Email Address
      description: Create new email address in the specified Connect Customer instance. For more information about email addresses,
        see Create email addresses in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmailAddressResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException; IdempotencyException; ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailAddressRequest'
      tags:
      - Email Addresses
  /email-addresses/{InstanceId}/{EmailAddressId}:
    delete:
      operationId: DeleteEmailAddress
      summary: Delete Email Address
      description: Deletes email address from the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEmailAddressResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEmailAddressRequest'
      tags:
      - Email Addresses
    get:
      operationId: DescribeEmailAddress
      summary: Describe Email Address
      description: Describe email address form the specified Connect Customer instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeEmailAddressResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeEmailAddressRequest'
      tags:
      - Email Addresses
    post:
      operationId: UpdateEmailAddressMetadata
      summary: Update Email Address Metadata
      description: Updates an email address metadata. For more information about email addresses, see Create email addresses
        in the Connect Customer Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEmailAddressMetadataResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: IdempotencyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdempotencyException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailAddressMetadataRequest'
      tags:
      - Email Addresses
  /queues/{InstanceId}/{QueueId}/email-addresses:
    get:
      operationId: ListQueueEmailAddresses
      summary: List Queue Email Addresses
      description: Lists all email addresses that are currently associated with a specific queue, providing details about
        which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent
        email address options and understand the available choices for different brands and business units. Important things
        to know The response includes metadata about each email address available for agent selection, including whether it's
        configured as the default outbound email. Agents can select from these email addresses when replying to inbound contacts
        or initiating outbound contacts in this queue. The list includes both explicitly associated email addresses and any
        default outbound email address configured for the queue. Results are paginated to handle queues with many associated
        email addresses (up to 50 per queue).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueueEmailAddressesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListQueueEmailAddressesRequest'
      tags:
      - Email Addresses
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: connect
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    AliasConfiguration:
      type: object
      properties:
        EmailAddressId:
          type: string
          description: The email address ID.
      required:
      - EmailAddressId
    CreateEmailAddressRequest:
      type: object
      properties:
        Description:
          type: string
          description: The description of the email address.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        EmailAddress:
          type: string
          description: The email address, including the domain.
        DisplayName:
          type: string
          description: The display name of email address
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
      - EmailAddress
    CreateEmailAddressResponse:
      type: object
      properties:
        EmailAddressId:
          type: string
          description: The identifier of the email address.
        EmailAddressArn:
          type: string
          description: The Amazon Resource Name (ARN) of the email address.
    DeleteEmailAddressRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        EmailAddressId:
          type: string
          description: The identifier of the email address.
      required:
      - InstanceId
      - EmailAddressId
    DeleteEmailAddressResponse:
      type: object
      properties: {}
    DescribeEmailAddressRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        EmailAddressId:
          type: string
          description: The identifier of the email address.
      required:
      - InstanceId
      - EmailAddressId
    DescribeEmailAddressResponse:
      type: object
      properties:
        EmailAddressId:
          type: string
          description: The identifier of the email address.
        EmailAddressArn:
          type: string
          description: The Amazon Resource Name (ARN) of the email address.
        EmailAddress:
          type: string
          description: The email address, including the domain.
        DisplayName:
          type: string
          description: The display name of email address
        Description:
          type: string
          description: The description of the email address.
        CreateTimestamp:
          type: string
          description: The email address creation timestamp in ISO 8601 Datetime.
        ModifiedTimestamp:
          type: string
          description: The email address last modification timestamp in ISO 8601 Datetime.
        AliasConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/AliasConfiguration'
          description: A list of alias configurations associated with this email address. Contains details about email addresses
            that forward to this primary email address. The list can contain at most one alias configuration per email address.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    EmailAddressSummary:
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the email address associated with the queue.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the email address associated with the queue.
        IsDefaultOutboundEmail:
          type: boolean
          description: Indicates whether this email address is configured as the default outbound email address for the queue.
            When set to true, this email address is used as the default sender for outbound email contacts from this queue.
    IdempotencyException:
      type: object
      properties:
        Message:
          type: string
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    ListQueueEmailAddressesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        QueueId:
          type: string
          description: The identifier for the queue.
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next
            request to retrieve the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
      required:
      - InstanceId
      - QueueId
    ListQueueEmailAddressesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
        EmailAddressMetadataList:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddressSummary'
          description: List of email address summary information for all email addresses associated with the queue. Each item
            contains the email address identifier, ARN, and configuration details.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
    ResourceConflictException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          $ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
    ServiceQuotaExceededExceptionReason:
      type: object
      properties:
        AttachedFileServiceQuotaExceededExceptionReason:
          type: string
          enum:
          - TOTAL_FILE_SIZE_EXCEEDED
          - TOTAL_FILE_COUNT_EXCEEDED
          description: Total file size of all files or total number of files exceeds the service quota
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateEmailAddressMetadataRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        EmailAddressId:
          type: string
          description: The identifier of the email address.
        Description:
          type: string
          description: The description of the email address.
        DisplayName:
          type: string
          description: The display name of email address.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
      required:
      - InstanceId
      - EmailAddressId
    UpdateEmailAddressMetadataResponse:
      type: object
      properties:
        EmailAddressId:
          type: string
          description: The identifier of the email address.
        EmailAddressArn:
          type: string
          description: The Amazon Resource Name (ARN) of the email address.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)