« blib/lib/Paws/Appflow/InforNexusSourceProperties.pm
↑ Summary
blib/lib/Paws/Appflow/ListConnectorEntitiesResponse.pm »
| 1 | |||
| 2 | package Paws::Appflow::ListConnectorEntities; | ||
| 3 | use Moose; | ||
| 4 | has ConnectorProfileName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectorProfileName'); | ||
| 5 | has ConnectorType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectorType'); | ||
| 6 | has EntitiesPath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'entitiesPath'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListConnectorEntities'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/list-connector-entities'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Appflow::ListConnectorEntitiesResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Appflow::ListConnectorEntities - Arguments for method ListConnectorEntities on L<Paws::Appflow> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListConnectorEntities on the | ||
| 25 | L<Amazon Appflow|Paws::Appflow> service. Use the attributes of this class | ||
| 26 | as arguments to method ListConnectorEntities. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListConnectorEntities. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $appflow = Paws->service('Appflow'); | ||
| 33 | my $ListConnectorEntitiesResponse = $appflow->ListConnectorEntities( | ||
| 34 | ConnectorProfileName => 'MyConnectorProfileName', # OPTIONAL | ||
| 35 | ConnectorType => 'Salesforce', # OPTIONAL | ||
| 36 | EntitiesPath => 'MyEntitiesPath', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ConnectorEntityMap = $ListConnectorEntitiesResponse->ConnectorEntityMap; | ||
| 41 | |||
| 42 | # Returns a L<Paws::Appflow::ListConnectorEntitiesResponse> object. | ||
| 43 | |||
| 44 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appflow/ListConnectorEntities> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ConnectorProfileName => Str | ||
| 51 | |||
| 52 | The name of the connector profile. The name is unique for each | ||
| 53 | C<ConnectorProfile> in the AWS account, and is used to query the | ||
| 54 | downstream connector. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 ConnectorType => Str | ||
| 59 | |||
| 60 | The type of connector, such as Salesforce, Amplitude, and so on. | ||
| 61 | |||
| 62 | Valid values are: C<"Salesforce">, C<"Singular">, C<"Slack">, C<"Redshift">, C<"S3">, C<"Marketo">, C<"Googleanalytics">, C<"Zendesk">, C<"Servicenow">, C<"Datadog">, C<"Trendmicro">, C<"Snowflake">, C<"Dynatrace">, C<"Infornexus">, C<"Amplitude">, C<"Veeva">, C<"EventBridge">, C<"LookoutMetrics">, C<"Upsolver">, C<"Honeycode">, C<"CustomerProfiles"> | ||
| 63 | |||
| 64 | =head2 EntitiesPath => Str | ||
| 65 | |||
| 66 | This optional parameter is specific to connector implementation. Some | ||
| 67 | connectors support multiple levels or categories of entities. You can | ||
| 68 | find out the list of roots for such providers by sending a request | ||
| 69 | without the C<entitiesPath> parameter. If the connector supports | ||
| 70 | entities at different roots, this initial request returns the list of | ||
| 71 | roots. Otherwise, this request returns all entities supported by the | ||
| 72 | provider. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method ListConnectorEntities in L<Paws::Appflow> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |