« blib/lib/Paws/RedshiftData/DescribeTableResponse.pm
↑ Summary
blib/lib/Paws/RedshiftData/ExecuteStatementOutput.pm »
| 1 | |||
| 2 | package Paws::RedshiftData::ExecuteStatement; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Database => (is => 'ro', isa => 'Str'); | ||
| 6 | has DbUser => (is => 'ro', isa => 'Str'); | ||
| 7 | has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::RedshiftData::SqlParameter]'); | ||
| 8 | has SecretArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has Sql => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has StatementName => (is => 'ro', isa => 'Str'); | ||
| 11 | has WithEvent => (is => 'ro', isa => 'Bool'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExecuteStatement'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedshiftData::ExecuteStatementOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::RedshiftData::ExecuteStatement - Arguments for method ExecuteStatement on L<Paws::RedshiftData> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ExecuteStatement on the | ||
| 29 | L<Redshift Data API Service|Paws::RedshiftData> service. Use the attributes of this class | ||
| 30 | as arguments to method ExecuteStatement. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecuteStatement. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $redshift-data = Paws->service('RedshiftData'); | ||
| 37 | my $ExecuteStatementOutput = $redshift -data->ExecuteStatement( | ||
| 38 | ClusterIdentifier => 'MyLocation', | ||
| 39 | Sql => 'MyStatementString', | ||
| 40 | Database => 'MyString', # OPTIONAL | ||
| 41 | DbUser => 'MyString', # OPTIONAL | ||
| 42 | Parameters => [ | ||
| 43 | { | ||
| 44 | Name => 'MyParameterName', | ||
| 45 | Value => 'MyParameterValue', # min: 1 | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | SecretArn => 'MySecretArn', # OPTIONAL | ||
| 51 | StatementName => 'MyStatementNameString', # OPTIONAL | ||
| 52 | WithEvent => 1, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ClusterIdentifier = $ExecuteStatementOutput->ClusterIdentifier; | ||
| 57 | my $CreatedAt = $ExecuteStatementOutput->CreatedAt; | ||
| 58 | my $Database = $ExecuteStatementOutput->Database; | ||
| 59 | my $DbUser = $ExecuteStatementOutput->DbUser; | ||
| 60 | my $Id = $ExecuteStatementOutput->Id; | ||
| 61 | my $SecretArn = $ExecuteStatementOutput->SecretArn; | ||
| 62 | |||
| 63 | # Returns a L<Paws::RedshiftData::ExecuteStatementOutput> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift-data/ExecuteStatement> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 72 | |||
| 73 | The cluster identifier. This parameter is required when authenticating | ||
| 74 | using either AWS Secrets Manager or temporary credentials. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Database => Str | ||
| 79 | |||
| 80 | The name of the database. This parameter is required when | ||
| 81 | authenticating using temporary credentials. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 DbUser => Str | ||
| 86 | |||
| 87 | The database user name. This parameter is required when authenticating | ||
| 88 | using temporary credentials. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Parameters => ArrayRef[L<Paws::RedshiftData::SqlParameter>] | ||
| 93 | |||
| 94 | The parameters for the SQL statement. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 SecretArn => Str | ||
| 99 | |||
| 100 | The name or ARN of the secret that enables access to the database. This | ||
| 101 | parameter is required when authenticating using AWS Secrets Manager. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> Sql => Str | ||
| 106 | |||
| 107 | The SQL statement text to run. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 StatementName => Str | ||
| 112 | |||
| 113 | The name of the SQL statement. You can name the SQL statement when you | ||
| 114 | create it to identify the query. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 WithEvent => Bool | ||
| 119 | |||
| 120 | A value that indicates whether to send an event to the Amazon | ||
| 121 | EventBridge event bus after the SQL statement runs. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method ExecuteStatement in L<Paws::RedshiftData> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |