Glue / Client / describe_connection_type

describe_connection_type

Glue.Client.describe_connection_type(**kwargs)

The DescribeConnectionType API provides full details of the supported options for a given connection type in Glue.

See also: AWS API Documentation

Request Syntax

response = client.describe_connection_type(
    ConnectionType='string'
)

Parameters:

ConnectionType (string) –

[REQUIRED]

The name of the connection type to be described.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionType': 'string',
    'Description': 'string',
    'Capabilities': {
        'SupportedAuthenticationTypes': [
            'BASIC'|'OAUTH2'|'CUSTOM'|'IAM',
        ],
        'SupportedDataOperations': [
            'READ'|'WRITE',
        ],
        'SupportedComputeEnvironments': [
            'SPARK'|'ATHENA'|'PYTHON',
        ]
    },
    'ConnectionProperties': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    },
    'ConnectionOptions': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    },
    'AuthenticationConfiguration': {
        'AuthenticationType': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        },
        'SecretArn': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        },
        'OAuth2Properties': {
            'string': {
                'Name': 'string',
                'Description': 'string',
                'Required': True|False,
                'DefaultValue': 'string',
                'PropertyTypes': [
                    'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
                ],
                'AllowedValues': [
                    {
                        'Description': 'string',
                        'Value': 'string'
                    },
                ],
                'DataOperationScopes': [
                    'READ'|'WRITE',
                ]
            }
        },
        'BasicAuthenticationProperties': {
            'string': {
                'Name': 'string',
                'Description': 'string',
                'Required': True|False,
                'DefaultValue': 'string',
                'PropertyTypes': [
                    'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
                ],
                'AllowedValues': [
                    {
                        'Description': 'string',
                        'Value': 'string'
                    },
                ],
                'DataOperationScopes': [
                    'READ'|'WRITE',
                ]
            }
        },
        'CustomAuthenticationProperties': {
            'string': {
                'Name': 'string',
                'Description': 'string',
                'Required': True|False,
                'DefaultValue': 'string',
                'PropertyTypes': [
                    'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
                ],
                'AllowedValues': [
                    {
                        'Description': 'string',
                        'Value': 'string'
                    },
                ],
                'DataOperationScopes': [
                    'READ'|'WRITE',
                ]
            }
        }
    },
    'ComputeEnvironmentConfigurations': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'ComputeEnvironment': 'SPARK'|'ATHENA'|'PYTHON',
            'SupportedAuthenticationTypes': [
                'BASIC'|'OAUTH2'|'CUSTOM'|'IAM',
            ],
            'ConnectionOptions': {
                'string': {
                    'Name': 'string',
                    'Description': 'string',
                    'Required': True|False,
                    'DefaultValue': 'string',
                    'PropertyTypes': [
                        'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
                    ],
                    'AllowedValues': [
                        {
                            'Description': 'string',
                            'Value': 'string'
                        },
                    ],
                    'DataOperationScopes': [
                        'READ'|'WRITE',
                    ]
                }
            },
            'ConnectionPropertyNameOverrides': {
                'string': 'string'
            },
            'ConnectionOptionNameOverrides': {
                'string': 'string'
            },
            'ConnectionPropertiesRequiredOverrides': [
                'string',
            ],
            'PhysicalConnectionPropertiesRequired': True|False
        }
    },
    'PhysicalConnectionRequirements': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    },
    'AthenaConnectionProperties': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    },
    'PythonConnectionProperties': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    },
    'SparkConnectionProperties': {
        'string': {
            'Name': 'string',
            'Description': 'string',
            'Required': True|False,
            'DefaultValue': 'string',
            'PropertyTypes': [
                'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
            ],
            'AllowedValues': [
                {
                    'Description': 'string',
                    'Value': 'string'
                },
            ],
            'DataOperationScopes': [
                'READ'|'WRITE',
            ]
        }
    }
}

Response Structure

• (dict) –

  • ConnectionType (string) –

    The name of the connection type.

  • Description (string) –

    A description of the connection type.

  • Capabilities (dict) –

    The supported authentication types, data interface types (compute environments), and data operations of the connector.

    • SupportedAuthenticationTypes (list) –

      A list of supported authentication types.

      • (string) –

    • SupportedDataOperations (list) –

      A list of supported data operations.

      • (string) –

    • SupportedComputeEnvironments (list) –

      A list of supported compute environments.

      • (string) –

  • ConnectionProperties (dict) –

    Connection properties which are common across compute environments.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

  • ConnectionOptions (dict) –

    Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties. ConnectionOptions defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

  • AuthenticationConfiguration (dict) –

    The type of authentication used for the connection.

    • AuthenticationType (dict) –

      The type of authentication for a connection.

      • Name (string) –

        The name of the property.

      • Description (string) –

        A description of the property.

      • Required (boolean) –

        Indicates whether the property is required.

      • DefaultValue (string) –

        The default value for the property.

      • PropertyTypes (list) –

        Describes the type of property.

        • (string) –

      • AllowedValues (list) –

        A list of AllowedValue objects representing the values allowed for the property.

        • (dict) –

          An object representing a value allowed for a property.

          • Description (string) –

            A description of the allowed value.

          • Value (string) –

            The value allowed for the property.

      • DataOperationScopes (list) –

        Indicates which data operations are applicable to the property.

        • (string) –

    • SecretArn (dict) –

      The Amazon Resource Name (ARN) for the Secrets Manager.

      • Name (string) –

        The name of the property.

      • Description (string) –

        A description of the property.

      • Required (boolean) –

        Indicates whether the property is required.

      • DefaultValue (string) –

        The default value for the property.

      • PropertyTypes (list) –

        Describes the type of property.

        • (string) –

      • AllowedValues (list) –

        A list of AllowedValue objects representing the values allowed for the property.

        • (dict) –

          An object representing a value allowed for a property.

          • Description (string) –

            A description of the allowed value.

          • Value (string) –

            The value allowed for the property.

      • DataOperationScopes (list) –

        Indicates which data operations are applicable to the property.

        • (string) –

    • OAuth2Properties (dict) –

      A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.

      • (string) –

        • (dict) –

          An object that defines a connection type for a compute environment.

          • Name (string) –

            The name of the property.

          • Description (string) –

            A description of the property.

          • Required (boolean) –

            Indicates whether the property is required.

          • DefaultValue (string) –

            The default value for the property.

          • PropertyTypes (list) –

            Describes the type of property.

            • (string) –

          • AllowedValues (list) –

            A list of AllowedValue objects representing the values allowed for the property.

            • (dict) –

              An object representing a value allowed for a property.

              • Description (string) –

                A description of the allowed value.

              • Value (string) –

                The value allowed for the property.

          • DataOperationScopes (list) –

            Indicates which data operations are applicable to the property.

            • (string) –

    • BasicAuthenticationProperties (dict) –

      A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.

      • (string) –

        • (dict) –

          An object that defines a connection type for a compute environment.

          • Name (string) –

            The name of the property.

          • Description (string) –

            A description of the property.

          • Required (boolean) –

            Indicates whether the property is required.

          • DefaultValue (string) –

            The default value for the property.

          • PropertyTypes (list) –

            Describes the type of property.

            • (string) –

          • AllowedValues (list) –

            A list of AllowedValue objects representing the values allowed for the property.

            • (dict) –

              An object representing a value allowed for a property.

              • Description (string) –

                A description of the allowed value.

              • Value (string) –

                The value allowed for the property.

          • DataOperationScopes (list) –

            Indicates which data operations are applicable to the property.

            • (string) –

    • CustomAuthenticationProperties (dict) –

      A map of key-value pairs for the custom authentication properties. Each value is a a Property object.

      • (string) –

        • (dict) –

          An object that defines a connection type for a compute environment.

          • Name (string) –

            The name of the property.

          • Description (string) –

            A description of the property.

          • Required (boolean) –

            Indicates whether the property is required.

          • DefaultValue (string) –

            The default value for the property.

          • PropertyTypes (list) –

            Describes the type of property.

            • (string) –

          • AllowedValues (list) –

            A list of AllowedValue objects representing the values allowed for the property.

            • (dict) –

              An object representing a value allowed for a property.

              • Description (string) –

                A description of the allowed value.

              • Value (string) –

                The value allowed for the property.

          • DataOperationScopes (list) –

            Indicates which data operations are applicable to the property.

            • (string) –

  • ComputeEnvironmentConfigurations (dict) –

    The compute environments that are supported by the connection.

    • (string) –

      • (dict) –

        An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the DescribeConnectionType API.

        • Name (string) –

          A name for the compute environment configuration.

        • Description (string) –

          A description of the compute environment.

        • ComputeEnvironment (string) –

          The type of compute environment.

        • SupportedAuthenticationTypes (list) –

          The supported authentication types for the compute environment.

          • (string) –

        • ConnectionOptions (dict) –

          The parameters used as connection options for the compute environment.

          • (string) –

            • (dict) –

              An object that defines a connection type for a compute environment.

              • Name (string) –

                The name of the property.

              • Description (string) –

                A description of the property.

              • Required (boolean) –

                Indicates whether the property is required.

              • DefaultValue (string) –

                The default value for the property.

              • PropertyTypes (list) –

                Describes the type of property.

                • (string) –

              • AllowedValues (list) –

                A list of AllowedValue objects representing the values allowed for the property.

                • (dict) –

                  An object representing a value allowed for a property.

                  • Description (string) –

                    A description of the allowed value.

                  • Value (string) –

                    The value allowed for the property.

              • DataOperationScopes (list) –

                Indicates which data operations are applicable to the property.

                • (string) –

        • ConnectionPropertyNameOverrides (dict) –

          The connection property name overrides for the compute environment.

          • (string) –

            • (string) –

        • ConnectionOptionNameOverrides (dict) –

          The connection option name overrides for the compute environment.

          • (string) –

            • (string) –

        • ConnectionPropertiesRequiredOverrides (list) –

          The connection properties that are required as overrides for the compute environment.

          • (string) –

        • PhysicalConnectionPropertiesRequired (boolean) –

          Indicates whether PhysicalConnectionProperties are required for the compute environment.

  • PhysicalConnectionRequirements (dict) –

    Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

  • AthenaConnectionProperties (dict) –

    Connection properties specific to the Athena compute environment.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

  • PythonConnectionProperties (dict) –

    Connection properties specific to the Python compute environment.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

  • SparkConnectionProperties (dict) –

    Connection properties specific to the Spark compute environment.

    • (string) –

      • (dict) –

        An object that defines a connection type for a compute environment.

        • Name (string) –

          The name of the property.

        • Description (string) –

          A description of the property.

        • Required (boolean) –

          Indicates whether the property is required.

        • DefaultValue (string) –

          The default value for the property.

        • PropertyTypes (list) –

          Describes the type of property.

          • (string) –

        • AllowedValues (list) –

          A list of AllowedValue objects representing the values allowed for the property.

          • (dict) –

            An object representing a value allowed for a property.

            • Description (string) –

              A description of the allowed value.

            • Value (string) –

              The value allowed for the property.

        • DataOperationScopes (list) –

          Indicates which data operations are applicable to the property.

          • (string) –

Exceptions

• Glue.Client.exceptions.ValidationException

• Glue.Client.exceptions.InvalidInputException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.AccessDeniedException