Amazonka.AppFlow.DescribeConnectorProfiles

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.

Creating a Request

data DescribeConnectorProfiles

See: newDescribeConnectorProfiles smart constructor.

Constructors

DescribeConnectorProfiles'

Fields

• connectorLabel :: Maybe Text

  The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

• connectorProfileNames :: Maybe [Text]

  The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

• connectorType :: Maybe ConnectorType

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

• maxResults :: Maybe Natural

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

• nextToken :: Maybe Text

  The pagination token for the next page of data.

Instances

ToJSON DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

toJSON :: DescribeConnectorProfiles -> Value

toEncoding :: DescribeConnectorProfiles -> Encoding

toJSONList :: [DescribeConnectorProfiles] -> Value

toEncodingList :: [DescribeConnectorProfiles] -> Encoding

ToHeaders DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

toHeaders :: DescribeConnectorProfiles -> [Header]

ToPath DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

toPath :: DescribeConnectorProfiles -> ByteString

ToQuery DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

toQuery :: DescribeConnectorProfiles -> QueryString

AWSRequest DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Associated Types

type AWSResponse DescribeConnectorProfiles

Methods

request :: (Service -> Service) -> DescribeConnectorProfiles -> Request DescribeConnectorProfiles

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeConnectorProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeConnectorProfiles)))

Generic DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Associated Types

type Rep DescribeConnectorProfiles :: Type -> Type

Methods

from :: DescribeConnectorProfiles -> Rep DescribeConnectorProfiles x

to :: Rep DescribeConnectorProfiles x -> DescribeConnectorProfiles

Read DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

readsPrec :: Int -> ReadS DescribeConnectorProfiles

readList :: ReadS [DescribeConnectorProfiles]

readPrec :: ReadPrec DescribeConnectorProfiles

readListPrec :: ReadPrec [DescribeConnectorProfiles]

Show DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

showsPrec :: Int -> DescribeConnectorProfiles -> ShowS

show :: DescribeConnectorProfiles -> String

showList :: [DescribeConnectorProfiles] -> ShowS

NFData DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

rnf :: DescribeConnectorProfiles -> ()

Eq DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

(==) :: DescribeConnectorProfiles -> DescribeConnectorProfiles -> Bool

(/=) :: DescribeConnectorProfiles -> DescribeConnectorProfiles -> Bool

Hashable DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

hashWithSalt :: Int -> DescribeConnectorProfiles -> Int

hash :: DescribeConnectorProfiles -> Int

type AWSResponse DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

type AWSResponse DescribeConnectorProfiles = DescribeConnectorProfilesResponse

type Rep DescribeConnectorProfiles

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

type Rep DescribeConnectorProfiles = D1 ('MetaData "DescribeConnectorProfiles" "Amazonka.AppFlow.DescribeConnectorProfiles" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DescribeConnectorProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectorLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectorProfileNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "connectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorType)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeConnectorProfiles :: DescribeConnectorProfiles

Create a value of DescribeConnectorProfiles with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeConnectorProfiles, describeConnectorProfiles_connectorLabel - The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

$sel:connectorProfileNames:DescribeConnectorProfiles', describeConnectorProfiles_connectorProfileNames - The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

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

$sel:maxResults:DescribeConnectorProfiles', describeConnectorProfiles_maxResults - 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).

DescribeConnectorProfiles, describeConnectorProfiles_nextToken - The pagination token for the next page of data.

Request Lenses

describeConnectorProfiles_connectorLabel :: Lens' DescribeConnectorProfiles (Maybe Text)

The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

describeConnectorProfiles_connectorProfileNames :: Lens' DescribeConnectorProfiles (Maybe [Text])

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

describeConnectorProfiles_connectorType :: Lens' DescribeConnectorProfiles (Maybe ConnectorType)

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

describeConnectorProfiles_maxResults :: Lens' DescribeConnectorProfiles (Maybe Natural)

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

describeConnectorProfiles_nextToken :: Lens' DescribeConnectorProfiles (Maybe Text)

The pagination token for the next page of data.

Destructuring the Response

data DescribeConnectorProfilesResponse

See: newDescribeConnectorProfilesResponse smart constructor.

Constructors

DescribeConnectorProfilesResponse'

Fields

• connectorProfileDetails :: Maybe [ConnectorProfile]

  Returns information about the connector profiles associated with the flow.

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Associated Types

type Rep DescribeConnectorProfilesResponse :: Type -> Type

Methods

from :: DescribeConnectorProfilesResponse -> Rep DescribeConnectorProfilesResponse x

to :: Rep DescribeConnectorProfilesResponse x -> DescribeConnectorProfilesResponse

Read DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

readsPrec :: Int -> ReadS DescribeConnectorProfilesResponse

readList :: ReadS [DescribeConnectorProfilesResponse]

readPrec :: ReadPrec DescribeConnectorProfilesResponse

readListPrec :: ReadPrec [DescribeConnectorProfilesResponse]

Show DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

showsPrec :: Int -> DescribeConnectorProfilesResponse -> ShowS

show :: DescribeConnectorProfilesResponse -> String

showList :: [DescribeConnectorProfilesResponse] -> ShowS

NFData DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

rnf :: DescribeConnectorProfilesResponse -> ()

Eq DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

Methods

(==) :: DescribeConnectorProfilesResponse -> DescribeConnectorProfilesResponse -> Bool

(/=) :: DescribeConnectorProfilesResponse -> DescribeConnectorProfilesResponse -> Bool

type Rep DescribeConnectorProfilesResponse

Defined in Amazonka.AppFlow.DescribeConnectorProfiles

type Rep DescribeConnectorProfilesResponse = D1 ('MetaData "DescribeConnectorProfilesResponse" "Amazonka.AppFlow.DescribeConnectorProfiles" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DescribeConnectorProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorProfileDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConnectorProfile])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConnectorProfilesResponse

Arguments

:: Int

$sel:httpStatus:DescribeConnectorProfilesResponse'

-> DescribeConnectorProfilesResponse

Create a value of DescribeConnectorProfilesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:connectorProfileDetails:DescribeConnectorProfilesResponse', describeConnectorProfilesResponse_connectorProfileDetails - Returns information about the connector profiles associated with the flow.

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

$sel:httpStatus:DescribeConnectorProfilesResponse', describeConnectorProfilesResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectorProfilesResponse_connectorProfileDetails :: Lens' DescribeConnectorProfilesResponse (Maybe [ConnectorProfile])

Returns information about the connector profiles associated with the flow.

describeConnectorProfilesResponse_nextToken :: Lens' DescribeConnectorProfilesResponse (Maybe Text)

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

describeConnectorProfilesResponse_httpStatus :: Lens' DescribeConnectorProfilesResponse Int

The response's http status code.