| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppFlow.DescribeConnectorProfiles
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.
Synopsis
- data DescribeConnectorProfiles = DescribeConnectorProfiles' {}
- newDescribeConnectorProfiles :: DescribeConnectorProfiles
- describeConnectorProfiles_connectorProfileNames :: Lens' DescribeConnectorProfiles (Maybe [Text])
- describeConnectorProfiles_nextToken :: Lens' DescribeConnectorProfiles (Maybe Text)
- describeConnectorProfiles_connectorType :: Lens' DescribeConnectorProfiles (Maybe ConnectorType)
- describeConnectorProfiles_maxResults :: Lens' DescribeConnectorProfiles (Maybe Natural)
- data DescribeConnectorProfilesResponse = DescribeConnectorProfilesResponse' {}
- newDescribeConnectorProfilesResponse :: Int -> DescribeConnectorProfilesResponse
- describeConnectorProfilesResponse_connectorProfileDetails :: Lens' DescribeConnectorProfilesResponse (Maybe [ConnectorProfile])
- describeConnectorProfilesResponse_nextToken :: Lens' DescribeConnectorProfilesResponse (Maybe Text)
- describeConnectorProfilesResponse_httpStatus :: Lens' DescribeConnectorProfilesResponse Int
Creating a Request
data DescribeConnectorProfiles Source #
See: newDescribeConnectorProfiles smart constructor.
Constructors
| DescribeConnectorProfiles' | |
Fields
| |
Instances
newDescribeConnectorProfiles :: DescribeConnectorProfiles Source #
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:
$sel:connectorProfileNames:DescribeConnectorProfiles', describeConnectorProfiles_connectorProfileNames - The name of the connector profile. The name is unique for each
ConnectorProfile in the Amazon Web Services account.
$sel:nextToken:DescribeConnectorProfiles', describeConnectorProfiles_nextToken - The pagination token for the next page of data.
$sel:connectorType: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).
Request Lenses
describeConnectorProfiles_connectorProfileNames :: Lens' DescribeConnectorProfiles (Maybe [Text]) Source #
The name of the connector profile. The name is unique for each
ConnectorProfile in the Amazon Web Services account.
describeConnectorProfiles_nextToken :: Lens' DescribeConnectorProfiles (Maybe Text) Source #
The pagination token for the next page of data.
describeConnectorProfiles_connectorType :: Lens' DescribeConnectorProfiles (Maybe ConnectorType) Source #
The type of connector, such as Salesforce, Amplitude, and so on.
describeConnectorProfiles_maxResults :: Lens' DescribeConnectorProfiles (Maybe Natural) Source #
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).
Destructuring the Response
data DescribeConnectorProfilesResponse Source #
See: newDescribeConnectorProfilesResponse smart constructor.
Constructors
| DescribeConnectorProfilesResponse' | |
Fields
| |
Instances
newDescribeConnectorProfilesResponse Source #
Arguments
| :: Int | |
| -> 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.
$sel:nextToken: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]) Source #
Returns information about the connector profiles associated with the flow.
describeConnectorProfilesResponse_nextToken :: Lens' DescribeConnectorProfilesResponse (Maybe Text) Source #
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 Source #
The response's http status code.