AWS Glue AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti… API

openapi: 3.2.0
info:
  title: 'AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti…'
  version: '2017-03-31'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti… across 2 of this provider''s published API definitions: amazon-glue-x-amz-target-awsglue-getdatacatalogencryptionsettings-api-openapi.yml, aws-glue-aws-glue-x-amz-target-awsglue-getdatacatalogencryptionsetti-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://glue.{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 AWS Glue multi-region endpoint
- url: https://glue.{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 AWS Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti…'
paths:
  /#X-Amz-Target=AWSGlue.GetDataCatalogEncryptionSettings:
    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: GetDataCatalogEncryptionSettings
      description: Retrieves the security configuration for a specified catalog.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataCatalogEncryptionSettingsResponse'
              examples:
                GetDataCatalogEncryptionSettings200Example:
                  summary: Default GetDataCatalogEncryptionSettings 200 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                GetDataCatalogEncryptionSettings480Example:
                  summary: Default GetDataCatalogEncryptionSettings 480 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '481':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                GetDataCatalogEncryptionSettings481Example:
                  summary: Default GetDataCatalogEncryptionSettings 481 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
        '482':
          description: OperationTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTimeoutException'
              examples:
                GetDataCatalogEncryptionSettings482Example:
                  summary: Default GetDataCatalogEncryptionSettings 482 response
                  x-microcks-default: true
                  value:
                    JobRunId: jr_abc123
                    State: SUCCEEDED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataCatalogEncryptionSettingsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetDataCatalogEncryptionSettings
      summary: Amazon Glue Get Data Catalog Encryption Settings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti…'
      security:
      - hmac: []
    servers:
    - url: http://glue.{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 AWS Glue multi-region endpoint
    - url: https://glue.{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 AWS Glue multi-region endpoint
    - url: http://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
    - url: https://glue.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
  /#GetDataCatalogEncryptionSettings:
    post:
      operationId: post#GetDataCatalogEncryptionSettings
      summary: Get Data Catalog Encryption Settings
      description: Retrieves the security configuration for a specified catalog.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDataCatalogEncryptionSettingsResponse_2'
        '500':
          description: InternalServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceException_2'
        '400':
          description: InvalidInputException; OperationTimeoutException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException_2'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSGlue.GetDataCatalogEncryptionSettings
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDataCatalogEncryptionSettingsRequest_2'
      tags:
      - 'AWS Glue #X Amz Target=AWSGlue.GetDataCatalogEncryptionSetti…'
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: GetDataCatalogEncryptionSettings
    servers:
    - url: https://glue.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    NameString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    InvalidInputException: {}
    DataCatalogEncryptionSettings:
      type: object
      properties:
        EncryptionAtRest:
          allOf:
          - $ref: '#/components/schemas/EncryptionAtRest'
          - description: Specifies the encryption-at-rest configuration for the Data Catalog.
        ConnectionPasswordEncryption:
          allOf:
          - $ref: '#/components/schemas/ConnectionPasswordEncryption'
          - description: When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.
      description: Contains configuration information for maintaining Data Catalog security.
    Boolean:
      type: boolean
    ConnectionPasswordEncryption:
      type: object
      required:
      - ReturnConnectionPasswordEncrypted
      properties:
        ReturnConnectionPasswordEncrypted:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: 'When the <code>ReturnConnectionPasswordEncrypted</code> flag is set to "true", passwords remain encrypted in the responses of <code>GetConnection</code> and <code>GetConnections</code>. This encryption takes effect independently from catalog encryption. '
        AwsKmsKeyId:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: <p>An KMS key that is used to encrypt the connection password. </p> <p>If connection password protection is enabled, the caller of <code>CreateConnection</code> and <code>UpdateConnection</code> needs at least <code>kms:Encrypt</code> permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog. </p> <p>You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.</p>
      description: <p>The data structure used by the Data Catalog to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p> <p>When a <code>CreationConnection</code> request arrives containing a password, the Data Catalog first encrypts the password using your KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.</p> <p>This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.</p>
    CatalogEncryptionMode:
      type: string
      enum:
      - DISABLED
      - SSE-KMS
    EncryptionAtRest:
      type: object
      required:
      - CatalogEncryptionMode
      properties:
        CatalogEncryptionMode:
          allOf:
          - $ref: '#/components/schemas/CatalogEncryptionMode'
          - description: The encryption-at-rest mode for encrypting Data Catalog data.
        SseAwsKmsKeyId:
          allOf:
          - $ref: '#/components/schemas/NameString'
          - description: The ID of the KMS key to use for encryption at rest.
      description: Specifies the encryption-at-rest configuration for the Data Catalog.
    CatalogIdString:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*'
    GetDataCatalogEncryptionSettingsResponse:
      type: object
      properties:
        DataCatalogEncryptionSettings:
          allOf:
          - $ref: '#/components/schemas/DataCatalogEncryptionSettings'
          - description: The requested security configuration.
    GetDataCatalogEncryptionSettingsRequest:
      type: object
      title: GetDataCatalogEncryptionSettingsRequest
      properties:
        CatalogId:
          allOf:
          - $ref: '#/components/schemas/CatalogIdString'
          - description: The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
    InternalServiceException: {}
    OperationTimeoutException: {}
    EncryptionAtRest_2:
      type: object
      properties:
        CatalogEncryptionMode:
          type: string
          enum:
          - DISABLED
          - SSE-KMS
          - SSE-KMS-WITH-SERVICE-ROLE
          description: The encryption-at-rest mode for encrypting Data Catalog data.
        SseAwsKmsKeyId:
          type: string
          description: The ID of the KMS key to use for encryption at rest.
        CatalogEncryptionServiceRole:
          type: string
          description: The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.
      required:
      - CatalogEncryptionMode
    InvalidInputException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
        FromFederationSource:
          type: boolean
          description: Indicates whether or not the exception relates to a federated source.
    DataCatalogEncryptionSettings_2:
      type: object
      properties:
        EncryptionAtRest:
          $ref: '#/components/schemas/EncryptionAtRest_2'
        ConnectionPasswordEncryption:
          $ref: '#/components/schemas/ConnectionPasswordEncryption_2'
    GetDataCatalogEncryptionSettingsRequest_2:
      type: object
      properties:
        CatalogId:
          type: string
          description: The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the Amazon Web Services account ID is used by default.
    InternalServiceException_2:
      type: object
      properties:
        Message:
          type: string
          description: A message describing the problem.
    GetDataCatalogEncryptionSettingsResponse_2:
      type: object
      properties:
        DataCatalogEncryptionSettings:
          $ref: '#/components/schemas/DataCatalogEncryptionSettings_2'
    ConnectionPasswordEncryption_2:
      type: object
      properties:
        ReturnConnectionPasswordEncrypted:
          type: boolean
          description: When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.
        AwsKmsKeyId:
          type: string
          description: An KMS key that is used to encrypt the connection password. If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
      required:
      - ReturnConnectionPasswordEncrypted
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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
    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: glue
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/glue/
x-refined-from:
- amazon-glue-x-amz-target-awsglue-getdatacatalogencryptionsettings-api-openapi.yml
- aws-glue-aws-glue-x-amz-target-awsglue-getdatacatalogencryptionsetti-api-openapi.yml
x-hasEquivalentPaths: true