« blib/lib/Paws/RedShift/DescribeEndpointAccess.pm
↑ Summary
blib/lib/Paws/RedShift/DescribeEventCategories.pm »
| 1 | |||
| 2 | package Paws::RedShift::DescribeEndpointAuthorization; | ||
| 3 | use Moose; | ||
| 4 | has Account => (is => 'ro', isa => 'Str'); | ||
| 5 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has Grantee => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEndpointAuthorization'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::EndpointAuthorizationList'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeEndpointAuthorizationResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RedShift::DescribeEndpointAuthorization - Arguments for method DescribeEndpointAuthorization on L<Paws::RedShift> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeEndpointAuthorization on the | ||
| 26 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeEndpointAuthorization. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEndpointAuthorization. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $redshift = Paws->service('RedShift'); | ||
| 34 | my $EndpointAuthorizationList = $redshift->DescribeEndpointAuthorization( | ||
| 35 | Account => 'MyString', # OPTIONAL | ||
| 36 | ClusterIdentifier => 'MyString', # OPTIONAL | ||
| 37 | Grantee => 1, # OPTIONAL | ||
| 38 | Marker => 'MyString', # OPTIONAL | ||
| 39 | MaxRecords => 1, # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $EndpointAuthorizationList = | ||
| 44 | $EndpointAuthorizationList->EndpointAuthorizationList; | ||
| 45 | my $Marker = $EndpointAuthorizationList->Marker; | ||
| 46 | |||
| 47 | # Returns a L<Paws::RedShift::EndpointAuthorizationList> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeEndpointAuthorization> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Account => Str | ||
| 56 | |||
| 57 | The AWS account ID of either the cluster owner (grantor) or grantee. If | ||
| 58 | C<Grantee> parameter is true, then the C<Account> value is of the | ||
| 59 | grantor. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ClusterIdentifier => Str | ||
| 64 | |||
| 65 | The cluster identifier of the cluster to access. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Grantee => Bool | ||
| 70 | |||
| 71 | Indicates whether to check authorization from a grantor or grantee | ||
| 72 | point of view. If true, Amazon Redshift returns endpoint authorizations | ||
| 73 | that you've been granted. If false (default), checks authorization from | ||
| 74 | a grantor point of view. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Marker => Str | ||
| 79 | |||
| 80 | An optional pagination token provided by a previous | ||
| 81 | C<DescribeEndpointAuthorization> request. If this parameter is | ||
| 82 | specified, the response includes only records beyond the marker, up to | ||
| 83 | the value specified by the C<MaxRecords> parameter. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 MaxRecords => Int | ||
| 88 | |||
| 89 | The maximum number of records to include in the response. If more | ||
| 90 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 91 | token called a C<Marker> is included in the response so that the | ||
| 92 | remaining results can be retrieved. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method DescribeEndpointAuthorization in L<Paws::RedShift> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |