« blib/lib/Paws/RDSData/CommitTransactionResponse.pm
↑ Summary
blib/lib/Paws/RDSData/ExecuteSqlResponse.pm »
| 1 | |||
| 2 | package Paws::RDSData::ExecuteSql; | ||
| 3 | use Moose; | ||
| 4 | has AwsSecretStoreArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'awsSecretStoreArn', required => 1); | ||
| 5 | has Database => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'database'); | ||
| 6 | has DbClusterOrInstanceArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dbClusterOrInstanceArn', required => 1); | ||
| 7 | has Schema => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'schema'); | ||
| 8 | has SqlStatements => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sqlStatements', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExecuteSql'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ExecuteSql'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDSData::ExecuteSqlResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RDSData::ExecuteSql - Arguments for method ExecuteSql on L<Paws::RDSData> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ExecuteSql on the | ||
| 27 | L<AWS RDS DataService|Paws::RDSData> service. Use the attributes of this class | ||
| 28 | as arguments to method ExecuteSql. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecuteSql. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $rds-data = Paws->service('RDSData'); | ||
| 35 | my $ExecuteSqlResponse = $rds -data->ExecuteSql( | ||
| 36 | AwsSecretStoreArn => 'MyArn', | ||
| 37 | DbClusterOrInstanceArn => 'MyArn', | ||
| 38 | SqlStatements => 'MySqlStatement', | ||
| 39 | Database => 'MyDbName', # OPTIONAL | ||
| 40 | Schema => 'MyDbName', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $SqlStatementResults = $ExecuteSqlResponse->SqlStatementResults; | ||
| 45 | |||
| 46 | # Returns a L<Paws::RDSData::ExecuteSqlResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds-data/ExecuteSql> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> AwsSecretStoreArn => Str | ||
| 55 | |||
| 56 | The Amazon Resource Name (ARN) of the secret that enables access to the | ||
| 57 | DB cluster. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 Database => Str | ||
| 62 | |||
| 63 | The name of the database. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> DbClusterOrInstanceArn => Str | ||
| 68 | |||
| 69 | The ARN of the Aurora Serverless DB cluster. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 Schema => Str | ||
| 74 | |||
| 75 | The name of the database schema. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> SqlStatements => Str | ||
| 80 | |||
| 81 | One or more SQL statements to run on the DB cluster. | ||
| 82 | |||
| 83 | You can separate SQL statements from each other with a semicolon (;). | ||
| 84 | Any valid SQL statement is permitted, including data definition, data | ||
| 85 | manipulation, and commit statements. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method ExecuteSql in L<Paws::RDSData> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |