[ aws . appflow ]

describe-connectors

Description

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don’t specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-connectors
[--connector-types <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--connector-types (list)

The type of connector, such as Salesforce, Amplitude, and so on.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Salesforce
  Singular
  Slack
  Redshift
  S3
  Marketo
  Googleanalytics
  Zendesk
  Servicenow
  Datadog
  Trendmicro
  Snowflake
  Dynatrace
  Infornexus
  Amplitude
  Veeva
  EventBridge
  LookoutMetrics
  Upsolver
  Honeycode
  CustomerProfiles

--next-token (string)

The pagination token for the next page of data.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

connectorConfigurations -> (map)

The configuration that is applied to the connectors used in the flow.

key -> (string)

value -> (structure)

The configuration settings related to a given connector.

canUseAsSource -> (boolean)

Specifies whether the connector can be used as a source.

canUseAsDestination -> (boolean)

Specifies whether the connector can be used as a destination.

supportedDestinationConnectors -> (list)

Lists the connectors that are available for use as destinations.

(string)

supportedSchedulingFrequencies -> (list)

Specifies the supported flow frequency for that connector.

(string)

isPrivateLinkEnabled -> (boolean)

Specifies if PrivateLink is enabled for that connector.

isPrivateLinkEndpointUrlRequired -> (boolean)

Specifies if a PrivateLink endpoint URL is required.

supportedTriggerTypes -> (list)

Specifies the supported trigger types for the flow.

(string)

connectorMetadata -> (structure)

Specifies connector-specific metadata such as oAuthScopes , supportedRegions , privateLinkServiceUrl , and so on.

Amplitude -> (structure)

The connector metadata specific to Amplitude.

Datadog -> (structure)

The connector metadata specific to Datadog.

Dynatrace -> (structure)

The connector metadata specific to Dynatrace.

GoogleAnalytics -> (structure)

The connector metadata specific to Google Analytics.

oAuthScopes -> (list)

The desired authorization scope for the Google Analytics account.

(string)

InforNexus -> (structure)

The connector metadata specific to Infor Nexus.

Marketo -> (structure)

The connector metadata specific to Marketo.

Redshift -> (structure)

The connector metadata specific to Amazon Redshift.

S3 -> (structure)

The connector metadata specific to Amazon S3.

Salesforce -> (structure)

The connector metadata specific to Salesforce.

oAuthScopes -> (list)

The desired authorization scope for the Salesforce account.

(string)

ServiceNow -> (structure)

The connector metadata specific to ServiceNow.

Singular -> (structure)

The connector metadata specific to Singular.

Slack -> (structure)

The connector metadata specific to Slack.

oAuthScopes -> (list)

The desired authorization scope for the Slack account.

(string)

Snowflake -> (structure)

The connector metadata specific to Snowflake.

supportedRegions -> (list)

Specifies the supported AWS Regions when using Snowflake.

(string)

Trendmicro -> (structure)

The connector metadata specific to Trend Micro.

Veeva -> (structure)

The connector metadata specific to Veeva.

Zendesk -> (structure)

The connector metadata specific to Zendesk.

oAuthScopes -> (list)

The desired authorization scope for the Zendesk account.

(string)

EventBridge -> (structure)

The connector metadata specific to Amazon EventBridge.

Upsolver -> (structure)

The connector metadata specific to Upsolver.

CustomerProfiles -> (structure)

The connector metadata specific to Amazon Connect Customer Profiles.

Honeycode -> (structure)

The connector metadata specific to Amazon Honeycode.

oAuthScopes -> (list)

The desired authorization scope for the Amazon Honeycode account.

(string)

nextToken -> (string)

The pagination token for the next page of data.