« blib/lib/Paws/RedshiftData/DescribeStatement.pm
↑ Summary
blib/lib/Paws/RedshiftData/DescribeTable.pm »
| 1 | |||
| 2 | package Paws::RedshiftData::DescribeStatementResponse; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str'); | ||
| 6 | has Database => (is => 'ro', isa => 'Str'); | ||
| 7 | has DbUser => (is => 'ro', isa => 'Str'); | ||
| 8 | has Duration => (is => 'ro', isa => 'Int'); | ||
| 9 | has Error => (is => 'ro', isa => 'Str'); | ||
| 10 | has HasResultSet => (is => 'ro', isa => 'Bool'); | ||
| 11 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has QueryParameters => (is => 'ro', isa => 'ArrayRef[Paws::RedshiftData::SqlParameter]'); | ||
| 13 | has QueryString => (is => 'ro', isa => 'Str'); | ||
| 14 | has RedshiftPid => (is => 'ro', isa => 'Int'); | ||
| 15 | has RedshiftQueryId => (is => 'ro', isa => 'Int'); | ||
| 16 | has ResultRows => (is => 'ro', isa => 'Int'); | ||
| 17 | has ResultSize => (is => 'ro', isa => 'Int'); | ||
| 18 | has SecretArn => (is => 'ro', isa => 'Str'); | ||
| 19 | has Status => (is => 'ro', isa => 'Str'); | ||
| 20 | has UpdatedAt => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::RedshiftData::DescribeStatementResponse | ||
| 29 | |||
| 30 | =head1 ATTRIBUTES | ||
| 31 | |||
| 32 | |||
| 33 | =head2 ClusterIdentifier => Str | ||
| 34 | |||
| 35 | The cluster identifier. | ||
| 36 | |||
| 37 | |||
| 38 | =head2 CreatedAt => Str | ||
| 39 | |||
| 40 | The date and time (UTC) when the SQL statement was submitted to run. | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Database => Str | ||
| 44 | |||
| 45 | The name of the database. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DbUser => Str | ||
| 49 | |||
| 50 | The database user name. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Duration => Int | ||
| 54 | |||
| 55 | The amount of time in nanoseconds that the statement ran. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Error => Str | ||
| 59 | |||
| 60 | The error message from the cluster if the SQL statement encountered an | ||
| 61 | error while running. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 HasResultSet => Bool | ||
| 65 | |||
| 66 | A value that indicates whether the statement has a result set. The | ||
| 67 | result set can be empty. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Id => Str | ||
| 71 | |||
| 72 | The identifier of the SQL statement described. This value is a | ||
| 73 | universally unique identifier (UUID) generated by Amazon Redshift Data | ||
| 74 | API. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 QueryParameters => ArrayRef[L<Paws::RedshiftData::SqlParameter>] | ||
| 78 | |||
| 79 | The parameters for the SQL statement. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 QueryString => Str | ||
| 83 | |||
| 84 | The SQL statement text. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 RedshiftPid => Int | ||
| 88 | |||
| 89 | The process identifier from Amazon Redshift. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 RedshiftQueryId => Int | ||
| 93 | |||
| 94 | The identifier of the query generated by Amazon Redshift. These | ||
| 95 | identifiers are also available in the C<query> column of the | ||
| 96 | C<STL_QUERY> system view. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 ResultRows => Int | ||
| 100 | |||
| 101 | Either the number of rows returned from the SQL statement or the number | ||
| 102 | of rows affected. If result size is greater than zero, the result rows | ||
| 103 | can be the number of rows affected by SQL statements such as INSERT, | ||
| 104 | UPDATE, DELETE, COPY, and others. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 ResultSize => Int | ||
| 108 | |||
| 109 | The size in bytes of the returned results. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 SecretArn => Str | ||
| 113 | |||
| 114 | The name or Amazon Resource Name (ARN) of the secret that enables | ||
| 115 | access to the database. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 Status => Str | ||
| 119 | |||
| 120 | The status of the SQL statement being described. Status values are | ||
| 121 | defined as follows: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | ABORTED - The query run was stopped by the user. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | ALL - A status value that includes all query statuses. This value can | ||
| 132 | be used to filter results. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | FAILED - The query run failed. | ||
| 137 | |||
| 138 | =item * | ||
| 139 | |||
| 140 | FINISHED - The query has finished running. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | PICKED - The query has been chosen to be run. | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | STARTED - The query run has started. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | SUBMITTED - The query was submitted, but not yet processed. | ||
| 153 | |||
| 154 | =back | ||
| 155 | |||
| 156 | |||
| 157 | Valid values are: C<"SUBMITTED">, C<"PICKED">, C<"STARTED">, C<"FINISHED">, C<"ABORTED">, C<"FAILED">, C<"ALL"> | ||
| 158 | =head2 UpdatedAt => Str | ||
| 159 | |||
| 160 | The date and time (UTC) that the metadata for the SQL statement was | ||
| 161 | last updated. An example is the time the status last changed. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 _request_id => Str | ||
| 165 | |||
| 166 | |||
| 167 | =cut | ||
| 168 | |||
| 169 | 1; |