AWS CLI Command Reference

[ aws . glue ]

register-connection-type

Description

Registers a custom connection type in Glue based on the configuration provided. This operation enables customers to configure custom connectors for any data source with REST-based APIs, eliminating the need for building custom Lambda connectors.

The registered connection type stores details about how requests and responses are interpreted by REST sources, including connection properties, authentication configuration, and REST configuration with entity definitions. Once registered, customers can create connections using this connection type and work with them the same way as natively supported Glue connectors.

Supports multiple authentication types including Basic, OAuth2 (Client Credentials, JWT Bearer, Authorization Code), and Custom Auth configurations.

See also: AWS API Documentation

Synopsis

  register-connection-type
--connection-type <value>
--integration-type <value>
[--description <value>]
--connection-properties <value>
--connector-authentication-configuration <value>
--rest-configuration <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--connection-type (string) [required]

The name of the connection type. Must be between 1 and 255 characters and must be prefixed with “REST-” to indicate it is a REST-based connector.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

--integration-type (string) [required]

The integration type for the connection. Currently only “REST” protocol is supported.

Possible values:

  • REST

--description (string)

A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.

Constraints:

  • min: 0
  • max: 1024

--connection-properties (structure) [required]

Defines the base URL and additional request parameters needed during connection creation for this connection type.

Url -> (structure)

The base instance URL for the endpoint that this connection type will connect to.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

AdditionalRequestParameters -> (list)

Key-value pairs of additional request parameters that may be needed during connection creation, such as API versions or service-specific configuration options.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

JSON Syntax:

{
  "Url": {
    "Name": "string",
    "KeyOverride": "string",
    "Required": true|false,
    "DefaultValue": "string",
    "AllowedValues": ["string", ...],
    "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
    "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
  },
  "AdditionalRequestParameters": [
    {
      "Name": "string",
      "KeyOverride": "string",
      "Required": true|false,
      "DefaultValue": "string",
      "AllowedValues": ["string", ...],
      "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
      "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
    }
    ...
  ]
}

--connector-authentication-configuration (structure) [required]

Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.

AuthenticationTypes -> (list) [required]

A list of authentication types supported by this connection type, such as Basic, OAuth2, or Custom authentication methods.

(string)

Possible values:

  • BASIC
  • OAUTH2
  • CUSTOM
  • IAM

OAuth2Properties -> (structure)

OAuth2 configuration container that defines the authentication properties and flow-specific configurations for OAuth2-based connections.

OAuth2GrantType -> (string) [required]

The OAuth2 grant type to use for authentication, such as CLIENT_CREDENTIALS, JWT_BEARER, or AUTHORIZATION_CODE.

Possible values:

  • CLIENT_CREDENTIALS
  • JWT_BEARER
  • AUTHORIZATION_CODE

ClientCredentialsProperties -> (structure)

Configuration properties specific to the OAuth2 Client Credentials grant type flow.

TokenUrl -> (structure)

The token endpoint URL where the client will request access tokens using client credentials.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

RequestMethod -> (string)

The HTTP method to use when making token requests, typically POST.

Possible values:

  • GET
  • POST

ContentType -> (string)

The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

Possible values:

  • APPLICATION_JSON
  • URL_ENCODED

ClientId -> (structure)

The OAuth2 client identifier provided by the authorization server.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

ClientSecret -> (structure)

The OAuth2 client secret provided by the authorization server.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

Scope -> (structure)

The OAuth2 scope that defines the level of access requested for the client credentials flow.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

TokenUrlParameters -> (list)

Additional parameters to include in token URL requests as key-value pairs.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

JWTBearerProperties -> (structure)

Configuration properties specific to the OAuth2 JWT Bearer grant type flow.

TokenUrl -> (structure)

The token endpoint URL where the JWT bearer token will be exchanged for an access token.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

RequestMethod -> (string)

The HTTP method to use when making JWT bearer token requests, typically POST.

Possible values:

  • GET
  • POST

ContentType -> (string)

The content type to use for JWT bearer token requests, such as application/x-www-form-urlencoded or application/json.

Possible values:

  • APPLICATION_JSON
  • URL_ENCODED

JwtToken -> (structure)

The JWT token to be used in the bearer token grant flow for authentication.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

TokenUrlParameters -> (list)

Additional parameters to include in token URL requests as key-value pairs.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

AuthorizationCodeProperties -> (structure)

Configuration properties specific to the OAuth2 Authorization Code grant type flow.

AuthorizationCodeUrl -> (structure)

The authorization endpoint URL where users will be redirected to grant authorization.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

AuthorizationCode -> (structure)

The authorization code received from the authorization server after user consent.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

RedirectUri -> (structure)

The redirect URI that must match the URI registered with the authorization server.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

TokenUrl -> (structure)

The token endpoint URL where the authorization code will be exchanged for an access token.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

RequestMethod -> (string)

The HTTP method to use when making token exchange requests, typically POST.

Possible values:

  • GET
  • POST

ContentType -> (string)

The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.

Possible values:

  • APPLICATION_JSON
  • URL_ENCODED

ClientId -> (structure)

The OAuth2 client identifier provided by the authorization server.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

ClientSecret -> (structure)

The OAuth2 client secret provided by the authorization server.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

Scope -> (structure)

The OAuth2 scope that defines the level of access requested for the authorization code flow.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

Prompt -> (structure)

The OAuth2 prompt parameter that controls the authorization server’s behavior during user authentication.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

TokenUrlParameters -> (list)

Additional parameters to include in token URL requests as key-value pairs.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

BasicAuthenticationProperties -> (structure)

Basic authentication configuration that defines the username and password properties for HTTP Basic authentication.

Username -> (structure)

The username property name to use for Basic authentication credentials.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

Password -> (structure)

The password property name to use for Basic authentication credentials.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

CustomAuthenticationProperties -> (structure)

Custom authentication configuration that allows for flexible authentication mechanisms beyond standard Basic and OAuth2 flows.

AuthenticationParameters -> (list) [required]

A map of custom authentication parameters that define the specific authentication mechanism and required properties.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

JSON Syntax:

{
  "AuthenticationTypes": ["BASIC"|"OAUTH2"|"CUSTOM"|"IAM", ...],
  "OAuth2Properties": {
    "OAuth2GrantType": "CLIENT_CREDENTIALS"|"JWT_BEARER"|"AUTHORIZATION_CODE",
    "ClientCredentialsProperties": {
      "TokenUrl": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "RequestMethod": "GET"|"POST",
      "ContentType": "APPLICATION_JSON"|"URL_ENCODED",
      "ClientId": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "ClientSecret": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "Scope": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "TokenUrlParameters": [
        {
          "Name": "string",
          "KeyOverride": "string",
          "Required": true|false,
          "DefaultValue": "string",
          "AllowedValues": ["string", ...],
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        }
        ...
      ]
    },
    "JWTBearerProperties": {
      "TokenUrl": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "RequestMethod": "GET"|"POST",
      "ContentType": "APPLICATION_JSON"|"URL_ENCODED",
      "JwtToken": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "TokenUrlParameters": [
        {
          "Name": "string",
          "KeyOverride": "string",
          "Required": true|false,
          "DefaultValue": "string",
          "AllowedValues": ["string", ...],
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        }
        ...
      ]
    },
    "AuthorizationCodeProperties": {
      "AuthorizationCodeUrl": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "AuthorizationCode": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "RedirectUri": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "TokenUrl": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "RequestMethod": "GET"|"POST",
      "ContentType": "APPLICATION_JSON"|"URL_ENCODED",
      "ClientId": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "ClientSecret": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "Scope": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "Prompt": {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      },
      "TokenUrlParameters": [
        {
          "Name": "string",
          "KeyOverride": "string",
          "Required": true|false,
          "DefaultValue": "string",
          "AllowedValues": ["string", ...],
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        }
        ...
      ]
    }
  },
  "BasicAuthenticationProperties": {
    "Username": {
      "Name": "string",
      "KeyOverride": "string",
      "Required": true|false,
      "DefaultValue": "string",
      "AllowedValues": ["string", ...],
      "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
      "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
    },
    "Password": {
      "Name": "string",
      "KeyOverride": "string",
      "Required": true|false,
      "DefaultValue": "string",
      "AllowedValues": ["string", ...],
      "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
      "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
    }
  },
  "CustomAuthenticationProperties": {
    "AuthenticationParameters": [
      {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      }
      ...
    ]
  }
}

--rest-configuration (structure) [required]

Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.

GlobalSourceConfiguration -> (structure)

Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.

RequestMethod -> (string)

The HTTP method to use for requests to this endpoint, such as GET, POST.

Possible values:

  • GET
  • POST

RequestPath -> (string)

The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

Constraints:

  • min: 1
  • max: 512
  • pattern: /[a-zA-Z0-9._~:/?#\[\]@!$&'()*+,;={}-]*

RequestParameters -> (list)

Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

ResponseConfiguration -> (structure)

Configuration that defines how to parse and extract data from API responses, including success and error handling.

ResultPath -> (string) [required]

The JSON path expression that identifies where the actual result data is located within the API response.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

ErrorPath -> (string)

The JSON path expression that identifies where error information is located within API responses when requests fail.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

PaginationConfiguration -> (structure)

Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

CursorConfiguration -> (structure)

Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

NextPage -> (structure) [required]

The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure)

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

OffsetConfiguration -> (structure)

Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

OffsetParameter -> (structure) [required]

The parameter name used to specify the starting position or offset for retrieving results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure) [required]

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

ValidationEndpointConfiguration -> (structure)

Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.

RequestMethod -> (string)

The HTTP method to use for requests to this endpoint, such as GET, POST.

Possible values:

  • GET
  • POST

RequestPath -> (string)

The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

Constraints:

  • min: 1
  • max: 512
  • pattern: /[a-zA-Z0-9._~:/?#\[\]@!$&'()*+,;={}-]*

RequestParameters -> (list)

Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

ResponseConfiguration -> (structure)

Configuration that defines how to parse and extract data from API responses, including success and error handling.

ResultPath -> (string) [required]

The JSON path expression that identifies where the actual result data is located within the API response.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

ErrorPath -> (string)

The JSON path expression that identifies where error information is located within API responses when requests fail.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

PaginationConfiguration -> (structure)

Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

CursorConfiguration -> (structure)

Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

NextPage -> (structure) [required]

The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure)

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

OffsetConfiguration -> (structure)

Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

OffsetParameter -> (structure) [required]

The parameter name used to specify the starting position or offset for retrieving results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure) [required]

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

EntityConfigurations -> (map)

A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_ -]+

value -> (structure)

Configuration that defines how to interact with a specific data entity through the REST API, including its access patterns and schema definition.

SourceConfiguration -> (structure)

The source configuration that defines how to make requests to access this entity’s data through the REST API.

RequestMethod -> (string)

The HTTP method to use for requests to this endpoint, such as GET, POST.

Possible values:

  • GET
  • POST

RequestPath -> (string)

The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

Constraints:

  • min: 1
  • max: 512
  • pattern: /[a-zA-Z0-9._~:/?#\[\]@!$&'()*+,;={}-]*

RequestParameters -> (list)

Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

(structure)

Defines a property configuration for connection types, default values, and where the property should be used in requests.

Name -> (string) [required]

The name of the property.

Constraints:

  • min: 1
  • max: 128

KeyOverride -> (string)

A key name to use when sending this property in API requests, if different from the display name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Required -> (boolean) [required]

Indicates whether the property is required.

DefaultValue -> (string)

The default value for the property.

AllowedValues -> (list)

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

(string)

PropertyLocation -> (string)

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

PropertyType -> (string) [required]

The data type of this property

Possible values:

  • USER_INPUT
  • SECRET
  • READ_ONLY
  • UNUSED
  • SECRET_OR_USER_INPUT

ResponseConfiguration -> (structure)

Configuration that defines how to parse and extract data from API responses, including success and error handling.

ResultPath -> (string) [required]

The JSON path expression that identifies where the actual result data is located within the API response.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

ErrorPath -> (string)

The JSON path expression that identifies where error information is located within API responses when requests fail.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

PaginationConfiguration -> (structure)

Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

CursorConfiguration -> (structure)

Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

NextPage -> (structure) [required]

The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure)

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

OffsetConfiguration -> (structure)

Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

OffsetParameter -> (structure) [required]

The parameter name used to specify the starting position or offset for retrieving results.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

LimitParameter -> (structure) [required]

The parameter name used to specify the maximum number of results to return per page.

Key -> (string)

The parameter key name that will be used in subsequent requests.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

DefaultValue -> (string)

The default value to use if the parameter cannot be extracted from the response.

Constraints:

  • min: 1
  • max: 1024
  • pattern: .*[^<>&'"].*

PropertyLocation -> (string)

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

Possible values:

  • HEADER
  • BODY
  • QUERY_PARAM
  • PATH

Value -> (structure)

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

ContentPath -> (string)

A JSON path expression that specifies how to extract a value from the response body content.

Constraints:

  • min: 1
  • max: 512
  • pattern: \$(\.[a-zA-Z0-9_.@\[\]\(\)-]+)*

HeaderKey -> (string)

The name of an HTTP response header from which to extract the value.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

Schema -> (map)

The schema definition for this entity, including field names, types, and other metadata that describes the structure of the data.

key -> (string)

Constraints:

  • min: 1

value -> (structure)

Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.

Name -> (string) [required]

The name of the field in the entity schema.

FieldDataType -> (string) [required]

The data type of the field.

Possible values:

  • INT
  • SMALLINT
  • BIGINT
  • FLOAT
  • LONG
  • DATE
  • BOOLEAN
  • MAP
  • ARRAY
  • STRING
  • TIMESTAMP
  • DECIMAL
  • BYTE
  • SHORT
  • DOUBLE
  • STRUCT
  • BINARY
  • UNION

JSON Syntax:

{
  "GlobalSourceConfiguration": {
    "RequestMethod": "GET"|"POST",
    "RequestPath": "string",
    "RequestParameters": [
      {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      }
      ...
    ],
    "ResponseConfiguration": {
      "ResultPath": "string",
      "ErrorPath": "string"
    },
    "PaginationConfiguration": {
      "CursorConfiguration": {
        "NextPage": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        },
        "LimitParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        }
      },
      "OffsetConfiguration": {
        "OffsetParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        },
        "LimitParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        }
      }
    }
  },
  "ValidationEndpointConfiguration": {
    "RequestMethod": "GET"|"POST",
    "RequestPath": "string",
    "RequestParameters": [
      {
        "Name": "string",
        "KeyOverride": "string",
        "Required": true|false,
        "DefaultValue": "string",
        "AllowedValues": ["string", ...],
        "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
        "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      }
      ...
    ],
    "ResponseConfiguration": {
      "ResultPath": "string",
      "ErrorPath": "string"
    },
    "PaginationConfiguration": {
      "CursorConfiguration": {
        "NextPage": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        },
        "LimitParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        }
      },
      "OffsetConfiguration": {
        "OffsetParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        },
        "LimitParameter": {
          "Key": "string",
          "DefaultValue": "string",
          "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          "Value": {
            "ContentPath": "string",
            "HeaderKey": "string"
          }
        }
      }
    }
  },
  "EntityConfigurations": {"string": {
        "SourceConfiguration": {
          "RequestMethod": "GET"|"POST",
          "RequestPath": "string",
          "RequestParameters": [
            {
              "Name": "string",
              "KeyOverride": "string",
              "Required": true|false,
              "DefaultValue": "string",
              "AllowedValues": ["string", ...],
              "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
              "PropertyType": "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
            }
            ...
          ],
          "ResponseConfiguration": {
            "ResultPath": "string",
            "ErrorPath": "string"
          },
          "PaginationConfiguration": {
            "CursorConfiguration": {
              "NextPage": {
                "Key": "string",
                "DefaultValue": "string",
                "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                "Value": {
                  "ContentPath": "string",
                  "HeaderKey": "string"
                }
              },
              "LimitParameter": {
                "Key": "string",
                "DefaultValue": "string",
                "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                "Value": {
                  "ContentPath": "string",
                  "HeaderKey": "string"
                }
              }
            },
            "OffsetConfiguration": {
              "OffsetParameter": {
                "Key": "string",
                "DefaultValue": "string",
                "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                "Value": {
                  "ContentPath": "string",
                  "HeaderKey": "string"
                }
              },
              "LimitParameter": {
                "Key": "string",
                "DefaultValue": "string",
                "PropertyLocation": "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                "Value": {
                  "ContentPath": "string",
                  "HeaderKey": "string"
                }
              }
            }
          }
        },
        "Schema": {"string": {
              "Name": "string",
              "FieldDataType": "INT"|"SMALLINT"|"BIGINT"|"FLOAT"|"LONG"|"DATE"|"BOOLEAN"|"MAP"|"ARRAY"|"STRING"|"TIMESTAMP"|"DECIMAL"|"BYTE"|"SHORT"|"DOUBLE"|"STRUCT"|"BINARY"|"UNION"
            }
          ...}
      }
    ...}
}

--tags (map)

The tags you assign to the connection type.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ConnectionTypeArn -> (string)

The Amazon Resource Name (ARN) of the registered connection type. This unique identifier can be used to reference the connection type in other Glue operations.

Constraints:

  • min: 1
  • max: 10240
  • pattern: arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*
© Copyright 2026, Amazon Web Services. Created using Sphinx.