Amazon WorkMail #X Amz Target=WorkMailService.CreateMobileDeviceAccessRule API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'Amazon WorkMail #X Amz Target=WorkMailService.AssociateDelegateToResource #X Amz Target=WorkMailService.AssociateDelegateToResource #X Amz Target=WorkMailService.CreateMobileDeviceAccessRule #X Amz Target=WorkMailService.CreateMobileDeviceAccessRule API'
  description: <p>WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.</p> <p>The WorkMail API is designed for the following scenarios:</p> <ul> <li> <p>Listing and describing organizations</p> </li> </ul> <ul> <li> <p>Managing users</p> </li> </ul> <ul> <li> <p>Managing groups</p> </li> </ul> <ul> <li> <p>Managing resources</p> </li> </ul> <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: workmail
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workmail-2017-10-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://workmail.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkMail multi-region endpoint
- url: https://workmail.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkMail multi-region endpoint
- url: http://workmail.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia)
- url: https://workmail.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=WorkMailService.CreateMobileDeviceAccessRule'
paths:
  /#X-Amz-Target=WorkMailService.CreateMobileDeviceAccessRule:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateMobileDeviceAccessRule
      description: Creates a new mobile device access rule for the specified WorkMail organization.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMobileDeviceAccessRuleResponse'
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '482':
          description: OrganizationNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationNotFoundException'
        '483':
          description: OrganizationStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationStateException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMobileDeviceAccessRuleRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkMailService.CreateMobileDeviceAccessRule
      summary: Amazon WorkMail Create Mobile Device Access Rule
      tags:
      - '#X Amz Target=WorkMailService.CreateMobileDeviceAccessRule'
components:
  schemas:
    DeviceTypeList:
      type: array
      items:
        $ref: '#/components/schemas/DeviceType'
      minItems: 1
      maxItems: 10
    MobileDeviceAccessRuleDescription:
      type: string
      pattern: '[\S\s]+'
      minLength: 1
      maxLength: 256
    MobileDeviceAccessRuleName:
      type: string
      pattern: '[\S\s]+'
      minLength: 1
      maxLength: 64
    CreateMobileDeviceAccessRuleResponse:
      type: object
      properties:
        MobileDeviceAccessRuleId:
          allOf:
          - $ref: '#/components/schemas/MobileDeviceAccessRuleId'
          - description: The identifier for the newly created mobile device access rule.
    OrganizationId:
      type: string
      pattern: ^m-[0-9a-f]{32}$
      minLength: 34
      maxLength: 34
    DeviceOperatingSystem:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 1
      maxLength: 256
    MobileDeviceAccessRuleEffect:
      type: string
      enum:
      - ALLOW
      - DENY
    DeviceType:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 1
      maxLength: 256
    DeviceModelList:
      type: array
      items:
        $ref: '#/components/schemas/DeviceModel'
      minItems: 1
      maxItems: 10
    OrganizationNotFoundException: {}
    MobileDeviceAccessRuleId:
      type: string
      pattern: '[a-zA-Z0-9_-]+'
      minLength: 1
      maxLength: 64
    DeviceModel:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 1
      maxLength: 256
    DeviceOperatingSystemList:
      type: array
      items:
        $ref: '#/components/schemas/DeviceOperatingSystem'
      minItems: 1
      maxItems: 10
    DeviceUserAgent:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 1
      maxLength: 256
    InvalidParameterException: {}
    LimitExceededException: {}
    DeviceUserAgentList:
      type: array
      items:
        $ref: '#/components/schemas/DeviceUserAgent'
      minItems: 1
      maxItems: 10
    CreateMobileDeviceAccessRuleRequest:
      type: object
      required:
      - OrganizationId
      - Name
      - Effect
      title: CreateMobileDeviceAccessRuleRequest
      properties:
        OrganizationId:
          allOf:
          - $ref: '#/components/schemas/OrganizationId'
          - description: The WorkMail organization under which the rule will be created.
        ClientToken:
          allOf:
          - $ref: '#/components/schemas/IdempotencyClientToken'
          - description: The idempotency token for the client request.
        Name:
          allOf:
          - $ref: '#/components/schemas/MobileDeviceAccessRuleName'
          - description: The rule name.
        Description:
          allOf:
          - $ref: '#/components/schemas/MobileDeviceAccessRuleDescription'
          - description: The rule description.
        Effect:
          allOf:
          - $ref: '#/components/schemas/MobileDeviceAccessRuleEffect'
          - description: The effect of the rule when it matches. Allowed values are <code>ALLOW</code> or <code>DENY</code>.
        DeviceTypes:
          allOf:
          - $ref: '#/components/schemas/DeviceTypeList'
          - description: Device types that the rule will match.
        NotDeviceTypes:
          allOf:
          - $ref: '#/components/schemas/DeviceTypeList'
          - description: Device types that the rule <b>will not</b> match. All other device types will match.
        DeviceModels:
          allOf:
          - $ref: '#/components/schemas/DeviceModelList'
          - description: Device models that the rule will match.
        NotDeviceModels:
          allOf:
          - $ref: '#/components/schemas/DeviceModelList'
          - description: Device models that the rule <b>will not</b> match. All other device models will match.
        DeviceOperatingSystems:
          allOf:
          - $ref: '#/components/schemas/DeviceOperatingSystemList'
          - description: Device operating systems that the rule will match.
        NotDeviceOperatingSystems:
          allOf:
          - $ref: '#/components/schemas/DeviceOperatingSystemList'
          - description: Device operating systems that the rule <b>will not</b> match. All other device operating systems will match.
        DeviceUserAgents:
          allOf:
          - $ref: '#/components/schemas/DeviceUserAgentList'
          - description: Device user agents that the rule will match.
        NotDeviceUserAgents:
          allOf:
          - $ref: '#/components/schemas/DeviceUserAgentList'
          - description: Device user agents that the rule <b>will not</b> match. All other device user agents will match.
    OrganizationStateException: {}
    IdempotencyClientToken:
      type: string
      pattern: '[\x21-\x7e]+'
      minLength: 1
      maxLength: 128
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/workmail/
x-hasEquivalentPaths: true