Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appflow ]

describe-connector-profiles

Description

Returns a list of connector-profile details matching the provided connector-profile names and connector-types . Both input lists are optional, and you can use them to filter the result.

If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-connector-profiles
[--connector-profile-names <value>]
[--connector-type <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--connector-profile-names (list)

The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.

(string)

Syntax:

"string" "string" ...

--connector-type (string)

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

Possible values:

  • Salesforce
  • Singular
  • Slack
  • Redshift
  • S3
  • Marketo
  • Googleanalytics
  • Zendesk
  • Servicenow
  • Datadog
  • Trendmicro
  • Snowflake
  • Dynatrace
  • Infornexus
  • Amplitude
  • Veeva
  • EventBridge
  • Upsolver

--max-results (integer)

Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).

--next-token (string)

The pagination token for the next page of data.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

connectorProfileDetails -> (list)

Returns information about the connector profiles associated with the flow.

(structure)

Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.

connectorProfileArn -> (string)

The Amazon Resource Name (ARN) of the connector profile.

connectorProfileName -> (string)

The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.

connectorType -> (string)

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

connectionMode -> (string)

Indicates the connection mode and if it is public or private.

credentialsArn -> (string)

The Amazon Resource Name (ARN) of the connector profile credentials.

connectorProfileProperties -> (structure)

The connector-specific properties of the profile configuration.

Amplitude -> (structure)

The connector-specific properties required by Amplitude.

Datadog -> (structure)

The connector-specific properties required by Datadog.

instanceUrl -> (string)

The location of the Datadog resource.

Dynatrace -> (structure)

The connector-specific properties required by Dynatrace.

instanceUrl -> (string)

The location of the Dynatrace resource.

GoogleAnalytics -> (structure)

The connector-specific properties required Google Analytics.

InforNexus -> (structure)

The connector-specific properties required by Infor Nexus.

instanceUrl -> (string)

The location of the Infor Nexus resource.

Marketo -> (structure)

The connector-specific properties required by Marketo.

instanceUrl -> (string)

The location of the Marketo resource.

Redshift -> (structure)

The connector-specific properties required by Amazon Redshift.

databaseUrl -> (string)

The JDBC URL of the Amazon Redshift cluster.

bucketName -> (string)

A name for the associated Amazon S3 bucket.

bucketPrefix -> (string)

The object key for the destination bucket in which Amazon AppFlow places the files.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role.

Salesforce -> (structure)

The connector-specific properties required by Salesforce.

instanceUrl -> (string)

The location of the Salesforce resource.

isSandboxEnvironment -> (boolean)

Indicates whether the connector profile applies to a sandbox or production environment.

ServiceNow -> (structure)

The connector-specific properties required by serviceNow.

instanceUrl -> (string)

The location of the ServiceNow resource.

Singular -> (structure)

The connector-specific properties required by Singular.

Slack -> (structure)

The connector-specific properties required by Slack.

instanceUrl -> (string)

The location of the Slack resource.

Snowflake -> (structure)

The connector-specific properties required by Snowflake.

warehouse -> (string)

The name of the Snowflake warehouse.

stage -> (string)

The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: DatabaseSchemaStage Name.

bucketName -> (string)

The name of the Amazon S3 bucket associated with Snowflake.

bucketPrefix -> (string)

The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

privateLinkServiceName -> (string)

The Snowflake Private Link service name to be used for private data transfers.

accountName -> (string)

The name of the account.

region -> (string)

The AWS Region of the Snowflake account.

Trendmicro -> (structure)

The connector-specific properties required by Trend Micro.

Veeva -> (structure)

The connector-specific properties required by Veeva.

instanceUrl -> (string)

The location of the Veeva resource.

Zendesk -> (structure)

The connector-specific properties required by Zendesk.

instanceUrl -> (string)

The location of the Zendesk resource.

createdAt -> (timestamp)

Specifies when the connector profile was created.

lastUpdatedAt -> (timestamp)

Specifies when the connector profile was last updated.

nextToken -> (string)

The pagination token for the next page of data. If nextToken=null , this means that all records have been fetched.