@types/aws-sdk2-types
Advanced tools
Comparing version 0.0.0 to 0.0.1
@@ -1,537 +0,567 @@ | ||
import {Request} from '../lib/request'; | ||
import {Response} from '../lib/response'; | ||
import {AWSError} from '../lib/error'; | ||
import {Service} from '../lib/service'; | ||
import {ServiceConfigurationOptions} from '../lib/service'; | ||
import {ConfigBase as Config} from '../lib/config-base'; | ||
import { ConfigBase as Config } from '../lib/config-base'; | ||
import { AWSError } from '../lib/error'; | ||
import { Request } from '../lib/request'; | ||
import { Response } from '../lib/response'; | ||
import { Service } from '../lib/service'; | ||
import { ServiceConfigurationOptions } from '../lib/service'; | ||
interface Blob {} | ||
declare class RDSDataService extends Service { | ||
/** | ||
* Constructs a service object. This object has one method for each API operation. | ||
*/ | ||
constructor(options?: RDSDataService.Types.ClientConfiguration) | ||
config: Config & RDSDataService.Types.ClientConfiguration; | ||
/** | ||
* Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set. The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated. | ||
*/ | ||
batchExecuteStatement(params: RDSDataService.Types.BatchExecuteStatementRequest, callback?: (err: AWSError, data: RDSDataService.Types.BatchExecuteStatementResponse) => void): Request<RDSDataService.Types.BatchExecuteStatementResponse, AWSError>; | ||
/** | ||
* Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set. The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated. | ||
*/ | ||
batchExecuteStatement(callback?: (err: AWSError, data: RDSDataService.Types.BatchExecuteStatementResponse) => void): Request<RDSDataService.Types.BatchExecuteStatementResponse, AWSError>; | ||
/** | ||
* Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled. | ||
*/ | ||
beginTransaction(params: RDSDataService.Types.BeginTransactionRequest, callback?: (err: AWSError, data: RDSDataService.Types.BeginTransactionResponse) => void): Request<RDSDataService.Types.BeginTransactionResponse, AWSError>; | ||
/** | ||
* Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled. | ||
*/ | ||
beginTransaction(callback?: (err: AWSError, data: RDSDataService.Types.BeginTransactionResponse) => void): Request<RDSDataService.Types.BeginTransactionResponse, AWSError>; | ||
/** | ||
* Ends a SQL transaction started with the BeginTransaction operation and commits the changes. | ||
*/ | ||
commitTransaction(params: RDSDataService.Types.CommitTransactionRequest, callback?: (err: AWSError, data: RDSDataService.Types.CommitTransactionResponse) => void): Request<RDSDataService.Types.CommitTransactionResponse, AWSError>; | ||
/** | ||
* Ends a SQL transaction started with the BeginTransaction operation and commits the changes. | ||
*/ | ||
commitTransaction(callback?: (err: AWSError, data: RDSDataService.Types.CommitTransactionResponse) => void): Request<RDSDataService.Types.CommitTransactionResponse, AWSError>; | ||
/** | ||
* Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. | ||
*/ | ||
executeSql(params: RDSDataService.Types.ExecuteSqlRequest, callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void): Request<RDSDataService.Types.ExecuteSqlResponse, AWSError>; | ||
/** | ||
* Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. | ||
*/ | ||
executeSql(callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void): Request<RDSDataService.Types.ExecuteSqlResponse, AWSError>; | ||
/** | ||
* Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. If the binary response data from the database is more than 1 MB, the call is terminated. | ||
*/ | ||
executeStatement(params: RDSDataService.Types.ExecuteStatementRequest, callback?: (err: AWSError, data: RDSDataService.Types.ExecuteStatementResponse) => void): Request<RDSDataService.Types.ExecuteStatementResponse, AWSError>; | ||
/** | ||
* Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. If the binary response data from the database is more than 1 MB, the call is terminated. | ||
*/ | ||
executeStatement(callback?: (err: AWSError, data: RDSDataService.Types.ExecuteStatementResponse) => void): Request<RDSDataService.Types.ExecuteStatementResponse, AWSError>; | ||
/** | ||
* Performs a rollback of a transaction. Rolling back a transaction cancels its changes. | ||
*/ | ||
rollbackTransaction(params: RDSDataService.Types.RollbackTransactionRequest, callback?: (err: AWSError, data: RDSDataService.Types.RollbackTransactionResponse) => void): Request<RDSDataService.Types.RollbackTransactionResponse, AWSError>; | ||
/** | ||
* Performs a rollback of a transaction. Rolling back a transaction cancels its changes. | ||
*/ | ||
rollbackTransaction(callback?: (err: AWSError, data: RDSDataService.Types.RollbackTransactionResponse) => void): Request<RDSDataService.Types.RollbackTransactionResponse, AWSError>; | ||
} | ||
declare namespace RDSDataService { | ||
export type Arn = string; | ||
export type ArrayOfArray = ArrayValue[]; | ||
export interface ArrayValue { | ||
/** | ||
* An array of Boolean values. | ||
* Constructs a service object. This object has one method for each API operation. | ||
*/ | ||
booleanValues?: BooleanArray; | ||
constructor(options?: RDSDataService.Types.ClientConfiguration); | ||
config: Config & RDSDataService.Types.ClientConfiguration; | ||
/** | ||
* An array of integers. | ||
* Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set. The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated. | ||
*/ | ||
longValues?: LongArray; | ||
batchExecuteStatement( | ||
params: RDSDataService.Types.BatchExecuteStatementRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.BatchExecuteStatementResponse) => void, | ||
): Request<RDSDataService.Types.BatchExecuteStatementResponse, AWSError>; | ||
/** | ||
* An array of floating-point numbers. | ||
* Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set. The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated. | ||
*/ | ||
doubleValues?: DoubleArray; | ||
batchExecuteStatement( | ||
callback?: (err: AWSError, data: RDSDataService.Types.BatchExecuteStatementResponse) => void, | ||
): Request<RDSDataService.Types.BatchExecuteStatementResponse, AWSError>; | ||
/** | ||
* An array of strings. | ||
* Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled. | ||
*/ | ||
stringValues?: StringArray; | ||
beginTransaction( | ||
params: RDSDataService.Types.BeginTransactionRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.BeginTransactionResponse) => void, | ||
): Request<RDSDataService.Types.BeginTransactionResponse, AWSError>; | ||
/** | ||
* An array of arrays. | ||
* Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled. | ||
*/ | ||
arrayValues?: ArrayOfArray; | ||
} | ||
export type ArrayValueList = Value[]; | ||
export interface BatchExecuteStatementRequest { | ||
beginTransaction( | ||
callback?: (err: AWSError, data: RDSDataService.Types.BeginTransactionResponse) => void, | ||
): Request<RDSDataService.Types.BeginTransactionResponse, AWSError>; | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
* Ends a SQL transaction started with the BeginTransaction operation and commits the changes. | ||
*/ | ||
resourceArn: Arn; | ||
commitTransaction( | ||
params: RDSDataService.Types.CommitTransactionRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.CommitTransactionResponse) => void, | ||
): Request<RDSDataService.Types.CommitTransactionResponse, AWSError>; | ||
/** | ||
* The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
* Ends a SQL transaction started with the BeginTransaction operation and commits the changes. | ||
*/ | ||
secretArn: Arn; | ||
commitTransaction( | ||
callback?: (err: AWSError, data: RDSDataService.Types.CommitTransactionResponse) => void, | ||
): Request<RDSDataService.Types.CommitTransactionResponse, AWSError>; | ||
/** | ||
* The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement. | ||
* Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. | ||
*/ | ||
sql: SqlStatement; | ||
executeSql( | ||
params: RDSDataService.Types.ExecuteSqlRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void, | ||
): Request<RDSDataService.Types.ExecuteSqlResponse, AWSError>; | ||
/** | ||
* The name of the database. | ||
* Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. | ||
*/ | ||
database?: DbName; | ||
executeSql( | ||
callback?: (err: AWSError, data: RDSDataService.Types.ExecuteSqlResponse) => void, | ||
): Request<RDSDataService.Types.ExecuteSqlResponse, AWSError>; | ||
/** | ||
* The name of the database schema. Currently, the schema parameter isn't supported. | ||
* Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. If the binary response data from the database is more than 1 MB, the call is terminated. | ||
*/ | ||
schema?: DbName; | ||
executeStatement( | ||
params: RDSDataService.Types.ExecuteStatementRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.ExecuteStatementResponse) => void, | ||
): Request<RDSDataService.Types.ExecuteStatementResponse, AWSError>; | ||
/** | ||
* The parameter set for the batch operation. The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options: Specify one or more empty parameter sets. Use the ExecuteStatement operation instead of the BatchExecuteStatement operation. Array parameters are not supported. | ||
* Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. If the binary response data from the database is more than 1 MB, the call is terminated. | ||
*/ | ||
parameterSets?: SqlParameterSets; | ||
executeStatement( | ||
callback?: (err: AWSError, data: RDSDataService.Types.ExecuteStatementResponse) => void, | ||
): Request<RDSDataService.Types.ExecuteStatementResponse, AWSError>; | ||
/** | ||
* The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter. | ||
* Performs a rollback of a transaction. Rolling back a transaction cancels its changes. | ||
*/ | ||
transactionId?: Id; | ||
} | ||
export interface BatchExecuteStatementResponse { | ||
rollbackTransaction( | ||
params: RDSDataService.Types.RollbackTransactionRequest, | ||
callback?: (err: AWSError, data: RDSDataService.Types.RollbackTransactionResponse) => void, | ||
): Request<RDSDataService.Types.RollbackTransactionResponse, AWSError>; | ||
/** | ||
* The execution results of each batch entry. | ||
* Performs a rollback of a transaction. Rolling back a transaction cancels its changes. | ||
*/ | ||
updateResults?: UpdateResults; | ||
} | ||
export interface BeginTransactionRequest { | ||
rollbackTransaction( | ||
callback?: (err: AWSError, data: RDSDataService.Types.RollbackTransactionResponse) => void, | ||
): Request<RDSDataService.Types.RollbackTransactionResponse, AWSError>; | ||
} | ||
declare namespace RDSDataService { | ||
export type Arn = string; | ||
export type ArrayOfArray = ArrayValue[]; | ||
export interface ArrayValue { | ||
/** | ||
* An array of Boolean values. | ||
*/ | ||
booleanValues?: BooleanArray; | ||
/** | ||
* An array of integers. | ||
*/ | ||
longValues?: LongArray; | ||
/** | ||
* An array of floating-point numbers. | ||
*/ | ||
doubleValues?: DoubleArray; | ||
/** | ||
* An array of strings. | ||
*/ | ||
stringValues?: StringArray; | ||
/** | ||
* An array of arrays. | ||
*/ | ||
arrayValues?: ArrayOfArray; | ||
} | ||
export type ArrayValueList = Value[]; | ||
export interface BatchExecuteStatementRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement. | ||
*/ | ||
sql: SqlStatement; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. Currently, the schema parameter isn't supported. | ||
*/ | ||
schema?: DbName; | ||
/** | ||
* The parameter set for the batch operation. The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options: Specify one or more empty parameter sets. Use the ExecuteStatement operation instead of the BatchExecuteStatement operation. Array parameters are not supported. | ||
*/ | ||
parameterSets?: SqlParameterSets; | ||
/** | ||
* The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter. | ||
*/ | ||
transactionId?: Id; | ||
} | ||
export interface BatchExecuteStatementResponse { | ||
/** | ||
* The execution results of each batch entry. | ||
*/ | ||
updateResults?: UpdateResults; | ||
} | ||
export interface BeginTransactionRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. | ||
*/ | ||
schema?: DbName; | ||
} | ||
export interface BeginTransactionResponse { | ||
/** | ||
* The transaction ID of the transaction started by the call. | ||
*/ | ||
transactionId?: Id; | ||
} | ||
export type _Blob = Buffer | Uint8Array | Blob | string; | ||
export type Boolean = boolean; | ||
export type BooleanArray = BoxedBoolean[]; | ||
export type BoxedBoolean = boolean; | ||
export type BoxedDouble = number; | ||
export type BoxedFloat = number; | ||
export type BoxedInteger = number; | ||
export type BoxedLong = number; | ||
export interface ColumnMetadata { | ||
/** | ||
* The name of the column. | ||
*/ | ||
name?: String; | ||
/** | ||
* The type of the column. | ||
*/ | ||
type?: Integer; | ||
/** | ||
* The database-specific data type of the column. | ||
*/ | ||
typeName?: String; | ||
/** | ||
* The label for the column. | ||
*/ | ||
label?: String; | ||
/** | ||
* The name of the schema that owns the table that includes the column. | ||
*/ | ||
schemaName?: String; | ||
/** | ||
* The name of the table that includes the column. | ||
*/ | ||
tableName?: String; | ||
/** | ||
* A value that indicates whether the column increments automatically. | ||
*/ | ||
isAutoIncrement?: Boolean; | ||
/** | ||
* A value that indicates whether an integer column is signed. | ||
*/ | ||
isSigned?: Boolean; | ||
/** | ||
* A value that indicates whether the column contains currency values. | ||
*/ | ||
isCurrency?: Boolean; | ||
/** | ||
* A value that indicates whether the column is case-sensitive. | ||
*/ | ||
isCaseSensitive?: Boolean; | ||
/** | ||
* A value that indicates whether the column is nullable. | ||
*/ | ||
nullable?: Integer; | ||
/** | ||
* The precision value of a decimal number column. | ||
*/ | ||
precision?: Integer; | ||
/** | ||
* The scale value of a decimal number column. | ||
*/ | ||
scale?: Integer; | ||
/** | ||
* The type of the column. | ||
*/ | ||
arrayBaseColumnType?: Integer; | ||
} | ||
export interface CommitTransactionRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The identifier of the transaction to end and commit. | ||
*/ | ||
transactionId: Id; | ||
} | ||
export interface CommitTransactionResponse { | ||
/** | ||
* The status of the commit operation. | ||
*/ | ||
transactionStatus?: TransactionStatus; | ||
} | ||
export type DbName = string; | ||
export type DecimalReturnType = 'STRING' | 'DOUBLE_OR_LONG' | string; | ||
export type DoubleArray = BoxedDouble[]; | ||
export interface ExecuteSqlRequest { | ||
/** | ||
* The ARN of the Aurora Serverless DB cluster. | ||
*/ | ||
dbClusterOrInstanceArn: Arn; | ||
/** | ||
* The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
*/ | ||
awsSecretStoreArn: Arn; | ||
/** | ||
* One or more SQL statements to run on the DB cluster. You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. | ||
*/ | ||
sqlStatements: SqlStatement; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. | ||
*/ | ||
schema?: DbName; | ||
} | ||
export interface ExecuteSqlResponse { | ||
/** | ||
* The results of the SQL statement or statements. | ||
*/ | ||
sqlStatementResults?: SqlStatementResults; | ||
} | ||
export interface ExecuteStatementRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The SQL statement to run. | ||
*/ | ||
sql: SqlStatement; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. Currently, the schema parameter isn't supported. | ||
*/ | ||
schema?: DbName; | ||
/** | ||
* The parameters for the SQL statement. Array parameters are not supported. | ||
*/ | ||
parameters?: SqlParametersList; | ||
/** | ||
* The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter. | ||
*/ | ||
transactionId?: Id; | ||
/** | ||
* A value that indicates whether to include metadata in the results. | ||
*/ | ||
includeResultMetadata?: Boolean; | ||
/** | ||
* A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out. For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures. | ||
*/ | ||
continueAfterTimeout?: Boolean; | ||
/** | ||
* Options that control how the result set is returned. | ||
*/ | ||
resultSetOptions?: ResultSetOptions; | ||
/** | ||
* A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field. For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide. | ||
*/ | ||
formatRecordsAs?: RecordsFormatType; | ||
} | ||
export interface ExecuteStatementResponse { | ||
/** | ||
* The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON. | ||
*/ | ||
records?: SqlRecords; | ||
/** | ||
* Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON. | ||
*/ | ||
columnMetadata?: Metadata; | ||
/** | ||
* The number of records updated by the request. | ||
*/ | ||
numberOfRecordsUpdated?: RecordsUpdated; | ||
/** | ||
* Values for fields generated during a DML request. <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> | ||
*/ | ||
generatedFields?: FieldList; | ||
/** | ||
* A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON. The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error. | ||
*/ | ||
formattedRecords?: FormattedSqlRecords; | ||
} | ||
export interface Field { | ||
/** | ||
* A NULL value. | ||
*/ | ||
isNull?: BoxedBoolean; | ||
/** | ||
* A value of Boolean data type. | ||
*/ | ||
booleanValue?: BoxedBoolean; | ||
/** | ||
* A value of long data type. | ||
*/ | ||
longValue?: BoxedLong; | ||
/** | ||
* A value of double data type. | ||
*/ | ||
doubleValue?: BoxedDouble; | ||
/** | ||
* A value of string data type. | ||
*/ | ||
stringValue?: String; | ||
/** | ||
* A value of BLOB data type. | ||
*/ | ||
blobValue?: _Blob; | ||
/** | ||
* An array of values. | ||
*/ | ||
arrayValue?: ArrayValue; | ||
} | ||
export type FieldList = Field[]; | ||
export type FormattedSqlRecords = string; | ||
export type Id = string; | ||
export type Integer = number; | ||
export type Long = number; | ||
export type LongArray = BoxedLong[]; | ||
export type LongReturnType = 'STRING' | 'LONG' | string; | ||
export type Metadata = ColumnMetadata[]; | ||
export type ParameterName = string; | ||
export interface Record { | ||
/** | ||
* The values returned in the record. | ||
*/ | ||
values?: Row; | ||
} | ||
export type Records = Record[]; | ||
export type RecordsFormatType = 'NONE' | 'JSON' | string; | ||
export type RecordsUpdated = number; | ||
export interface ResultFrame { | ||
/** | ||
* The result-set metadata in the result set. | ||
*/ | ||
resultSetMetadata?: ResultSetMetadata; | ||
/** | ||
* The records in the result set. | ||
*/ | ||
records?: Records; | ||
} | ||
export interface ResultSetMetadata { | ||
/** | ||
* The number of columns in the result set. | ||
*/ | ||
columnCount?: Long; | ||
/** | ||
* The metadata of the columns in the result set. | ||
*/ | ||
columnMetadata?: Metadata; | ||
} | ||
export interface ResultSetOptions { | ||
/** | ||
* A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise. Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values. | ||
*/ | ||
decimalReturnType?: DecimalReturnType; | ||
/** | ||
* A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors. | ||
*/ | ||
longReturnType?: LongReturnType; | ||
} | ||
export interface RollbackTransactionRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The identifier of the transaction to roll back. | ||
*/ | ||
transactionId: Id; | ||
} | ||
export interface RollbackTransactionResponse { | ||
/** | ||
* The status of the rollback operation. | ||
*/ | ||
transactionStatus?: TransactionStatus; | ||
} | ||
export type Row = Value[]; | ||
export interface SqlParameter { | ||
/** | ||
* The name of the parameter. | ||
*/ | ||
name?: ParameterName; | ||
/** | ||
* The value of the parameter. | ||
*/ | ||
value?: Field; | ||
/** | ||
* A hint that specifies the correct object type for data type mapping. Possible values are as follows: DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD. DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database. JSON - The corresponding String parameter value is sent as an object of JSON type to the database. TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF]. TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF]. UUID - The corresponding String parameter value is sent as an object of UUID type to the database. | ||
*/ | ||
typeHint?: TypeHint; | ||
} | ||
export type SqlParameterSets = SqlParametersList[]; | ||
export type SqlParametersList = SqlParameter[]; | ||
export type SqlRecords = FieldList[]; | ||
export type SqlStatement = string; | ||
export interface SqlStatementResult { | ||
/** | ||
* The result set of the SQL statement. | ||
*/ | ||
resultFrame?: ResultFrame; | ||
/** | ||
* The number of records updated by a SQL statement. | ||
*/ | ||
numberOfRecordsUpdated?: RecordsUpdated; | ||
} | ||
export type SqlStatementResults = SqlStatementResult[]; | ||
export type String = string; | ||
export type StringArray = String[]; | ||
export interface StructValue { | ||
/** | ||
* The attributes returned in the record. | ||
*/ | ||
attributes?: ArrayValueList; | ||
} | ||
export type TransactionStatus = string; | ||
export type TypeHint = 'JSON' | 'UUID' | 'TIMESTAMP' | 'DATE' | 'TIME' | 'DECIMAL' | string; | ||
export interface UpdateResult { | ||
/** | ||
* Values for fields generated during the request. | ||
*/ | ||
generatedFields?: FieldList; | ||
} | ||
export type UpdateResults = UpdateResult[]; | ||
export interface Value { | ||
/** | ||
* A NULL value. | ||
*/ | ||
isNull?: BoxedBoolean; | ||
/** | ||
* A value for a column of BIT data type. | ||
*/ | ||
bitValue?: BoxedBoolean; | ||
/** | ||
* A value for a column of big integer data type. | ||
*/ | ||
bigIntValue?: BoxedLong; | ||
/** | ||
* A value for a column of integer data type. | ||
*/ | ||
intValue?: BoxedInteger; | ||
/** | ||
* A value for a column of double data type. | ||
*/ | ||
doubleValue?: BoxedDouble; | ||
/** | ||
* A value for a column of real data type. | ||
*/ | ||
realValue?: BoxedFloat; | ||
/** | ||
* A value for a column of string data type. | ||
*/ | ||
stringValue?: String; | ||
/** | ||
* A value for a column of BLOB data type. | ||
*/ | ||
blobValue?: _Blob; | ||
/** | ||
* An array of column values. | ||
*/ | ||
arrayValues?: ArrayValueList; | ||
/** | ||
* A value for a column of STRUCT data type. | ||
*/ | ||
structValue?: StructValue; | ||
} | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. | ||
*/ | ||
resourceArn: Arn; | ||
export type apiVersion = '2018-08-01' | 'latest' | string; | ||
export interface ClientApiVersions { | ||
/** | ||
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. | ||
*/ | ||
apiVersion?: apiVersion; | ||
} | ||
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
* Contains interfaces for use with the RDSDataService client. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. | ||
*/ | ||
schema?: DbName; | ||
} | ||
export interface BeginTransactionResponse { | ||
/** | ||
* The transaction ID of the transaction started by the call. | ||
*/ | ||
transactionId?: Id; | ||
} | ||
export type _Blob = Buffer|Uint8Array|Blob|string; | ||
export type Boolean = boolean; | ||
export type BooleanArray = BoxedBoolean[]; | ||
export type BoxedBoolean = boolean; | ||
export type BoxedDouble = number; | ||
export type BoxedFloat = number; | ||
export type BoxedInteger = number; | ||
export type BoxedLong = number; | ||
export interface ColumnMetadata { | ||
/** | ||
* The name of the column. | ||
*/ | ||
name?: String; | ||
/** | ||
* The type of the column. | ||
*/ | ||
type?: Integer; | ||
/** | ||
* The database-specific data type of the column. | ||
*/ | ||
typeName?: String; | ||
/** | ||
* The label for the column. | ||
*/ | ||
label?: String; | ||
/** | ||
* The name of the schema that owns the table that includes the column. | ||
*/ | ||
schemaName?: String; | ||
/** | ||
* The name of the table that includes the column. | ||
*/ | ||
tableName?: String; | ||
/** | ||
* A value that indicates whether the column increments automatically. | ||
*/ | ||
isAutoIncrement?: Boolean; | ||
/** | ||
* A value that indicates whether an integer column is signed. | ||
*/ | ||
isSigned?: Boolean; | ||
/** | ||
* A value that indicates whether the column contains currency values. | ||
*/ | ||
isCurrency?: Boolean; | ||
/** | ||
* A value that indicates whether the column is case-sensitive. | ||
*/ | ||
isCaseSensitive?: Boolean; | ||
/** | ||
* A value that indicates whether the column is nullable. | ||
*/ | ||
nullable?: Integer; | ||
/** | ||
* The precision value of a decimal number column. | ||
*/ | ||
precision?: Integer; | ||
/** | ||
* The scale value of a decimal number column. | ||
*/ | ||
scale?: Integer; | ||
/** | ||
* The type of the column. | ||
*/ | ||
arrayBaseColumnType?: Integer; | ||
} | ||
export interface CommitTransactionRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The identifier of the transaction to end and commit. | ||
*/ | ||
transactionId: Id; | ||
} | ||
export interface CommitTransactionResponse { | ||
/** | ||
* The status of the commit operation. | ||
*/ | ||
transactionStatus?: TransactionStatus; | ||
} | ||
export type DbName = string; | ||
export type DecimalReturnType = "STRING"|"DOUBLE_OR_LONG"|string; | ||
export type DoubleArray = BoxedDouble[]; | ||
export interface ExecuteSqlRequest { | ||
/** | ||
* The ARN of the Aurora Serverless DB cluster. | ||
*/ | ||
dbClusterOrInstanceArn: Arn; | ||
/** | ||
* The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
*/ | ||
awsSecretStoreArn: Arn; | ||
/** | ||
* One or more SQL statements to run on the DB cluster. You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. | ||
*/ | ||
sqlStatements: SqlStatement; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. | ||
*/ | ||
schema?: DbName; | ||
} | ||
export interface ExecuteSqlResponse { | ||
/** | ||
* The results of the SQL statement or statements. | ||
*/ | ||
sqlStatementResults?: SqlStatementResults; | ||
} | ||
export interface ExecuteStatementRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret. For information about creating the secret, see Create a database secret. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The SQL statement to run. | ||
*/ | ||
sql: SqlStatement; | ||
/** | ||
* The name of the database. | ||
*/ | ||
database?: DbName; | ||
/** | ||
* The name of the database schema. Currently, the schema parameter isn't supported. | ||
*/ | ||
schema?: DbName; | ||
/** | ||
* The parameters for the SQL statement. Array parameters are not supported. | ||
*/ | ||
parameters?: SqlParametersList; | ||
/** | ||
* The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter. | ||
*/ | ||
transactionId?: Id; | ||
/** | ||
* A value that indicates whether to include metadata in the results. | ||
*/ | ||
includeResultMetadata?: Boolean; | ||
/** | ||
* A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out. For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures. | ||
*/ | ||
continueAfterTimeout?: Boolean; | ||
/** | ||
* Options that control how the result set is returned. | ||
*/ | ||
resultSetOptions?: ResultSetOptions; | ||
/** | ||
* A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field. For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide. | ||
*/ | ||
formatRecordsAs?: RecordsFormatType; | ||
} | ||
export interface ExecuteStatementResponse { | ||
/** | ||
* The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON. | ||
*/ | ||
records?: SqlRecords; | ||
/** | ||
* Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON. | ||
*/ | ||
columnMetadata?: Metadata; | ||
/** | ||
* The number of records updated by the request. | ||
*/ | ||
numberOfRecordsUpdated?: RecordsUpdated; | ||
/** | ||
* Values for fields generated during a DML request. <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note> | ||
*/ | ||
generatedFields?: FieldList; | ||
/** | ||
* A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON. The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error. | ||
*/ | ||
formattedRecords?: FormattedSqlRecords; | ||
} | ||
export interface Field { | ||
/** | ||
* A NULL value. | ||
*/ | ||
isNull?: BoxedBoolean; | ||
/** | ||
* A value of Boolean data type. | ||
*/ | ||
booleanValue?: BoxedBoolean; | ||
/** | ||
* A value of long data type. | ||
*/ | ||
longValue?: BoxedLong; | ||
/** | ||
* A value of double data type. | ||
*/ | ||
doubleValue?: BoxedDouble; | ||
/** | ||
* A value of string data type. | ||
*/ | ||
stringValue?: String; | ||
/** | ||
* A value of BLOB data type. | ||
*/ | ||
blobValue?: _Blob; | ||
/** | ||
* An array of values. | ||
*/ | ||
arrayValue?: ArrayValue; | ||
} | ||
export type FieldList = Field[]; | ||
export type FormattedSqlRecords = string; | ||
export type Id = string; | ||
export type Integer = number; | ||
export type Long = number; | ||
export type LongArray = BoxedLong[]; | ||
export type LongReturnType = "STRING"|"LONG"|string; | ||
export type Metadata = ColumnMetadata[]; | ||
export type ParameterName = string; | ||
export interface Record { | ||
/** | ||
* The values returned in the record. | ||
*/ | ||
values?: Row; | ||
} | ||
export type Records = Record[]; | ||
export type RecordsFormatType = "NONE"|"JSON"|string; | ||
export type RecordsUpdated = number; | ||
export interface ResultFrame { | ||
/** | ||
* The result-set metadata in the result set. | ||
*/ | ||
resultSetMetadata?: ResultSetMetadata; | ||
/** | ||
* The records in the result set. | ||
*/ | ||
records?: Records; | ||
} | ||
export interface ResultSetMetadata { | ||
/** | ||
* The number of columns in the result set. | ||
*/ | ||
columnCount?: Long; | ||
/** | ||
* The metadata of the columns in the result set. | ||
*/ | ||
columnMetadata?: Metadata; | ||
} | ||
export interface ResultSetOptions { | ||
/** | ||
* A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise. Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values. | ||
*/ | ||
decimalReturnType?: DecimalReturnType; | ||
/** | ||
* A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors. | ||
*/ | ||
longReturnType?: LongReturnType; | ||
} | ||
export interface RollbackTransactionRequest { | ||
/** | ||
* The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
*/ | ||
resourceArn: Arn; | ||
/** | ||
* The name or ARN of the secret that enables access to the DB cluster. | ||
*/ | ||
secretArn: Arn; | ||
/** | ||
* The identifier of the transaction to roll back. | ||
*/ | ||
transactionId: Id; | ||
} | ||
export interface RollbackTransactionResponse { | ||
/** | ||
* The status of the rollback operation. | ||
*/ | ||
transactionStatus?: TransactionStatus; | ||
} | ||
export type Row = Value[]; | ||
export interface SqlParameter { | ||
/** | ||
* The name of the parameter. | ||
*/ | ||
name?: ParameterName; | ||
/** | ||
* The value of the parameter. | ||
*/ | ||
value?: Field; | ||
/** | ||
* A hint that specifies the correct object type for data type mapping. Possible values are as follows: DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD. DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database. JSON - The corresponding String parameter value is sent as an object of JSON type to the database. TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF]. TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF]. UUID - The corresponding String parameter value is sent as an object of UUID type to the database. | ||
*/ | ||
typeHint?: TypeHint; | ||
} | ||
export type SqlParameterSets = SqlParametersList[]; | ||
export type SqlParametersList = SqlParameter[]; | ||
export type SqlRecords = FieldList[]; | ||
export type SqlStatement = string; | ||
export interface SqlStatementResult { | ||
/** | ||
* The result set of the SQL statement. | ||
*/ | ||
resultFrame?: ResultFrame; | ||
/** | ||
* The number of records updated by a SQL statement. | ||
*/ | ||
numberOfRecordsUpdated?: RecordsUpdated; | ||
} | ||
export type SqlStatementResults = SqlStatementResult[]; | ||
export type String = string; | ||
export type StringArray = String[]; | ||
export interface StructValue { | ||
/** | ||
* The attributes returned in the record. | ||
*/ | ||
attributes?: ArrayValueList; | ||
} | ||
export type TransactionStatus = string; | ||
export type TypeHint = "JSON"|"UUID"|"TIMESTAMP"|"DATE"|"TIME"|"DECIMAL"|string; | ||
export interface UpdateResult { | ||
/** | ||
* Values for fields generated during the request. | ||
*/ | ||
generatedFields?: FieldList; | ||
} | ||
export type UpdateResults = UpdateResult[]; | ||
export interface Value { | ||
/** | ||
* A NULL value. | ||
*/ | ||
isNull?: BoxedBoolean; | ||
/** | ||
* A value for a column of BIT data type. | ||
*/ | ||
bitValue?: BoxedBoolean; | ||
/** | ||
* A value for a column of big integer data type. | ||
*/ | ||
bigIntValue?: BoxedLong; | ||
/** | ||
* A value for a column of integer data type. | ||
*/ | ||
intValue?: BoxedInteger; | ||
/** | ||
* A value for a column of double data type. | ||
*/ | ||
doubleValue?: BoxedDouble; | ||
/** | ||
* A value for a column of real data type. | ||
*/ | ||
realValue?: BoxedFloat; | ||
/** | ||
* A value for a column of string data type. | ||
*/ | ||
stringValue?: String; | ||
/** | ||
* A value for a column of BLOB data type. | ||
*/ | ||
blobValue?: _Blob; | ||
/** | ||
* An array of column values. | ||
*/ | ||
arrayValues?: ArrayValueList; | ||
/** | ||
* A value for a column of STRUCT data type. | ||
*/ | ||
structValue?: StructValue; | ||
} | ||
/** | ||
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. | ||
*/ | ||
export type apiVersion = "2018-08-01"|"latest"|string; | ||
export interface ClientApiVersions { | ||
/** | ||
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. | ||
*/ | ||
apiVersion?: apiVersion; | ||
} | ||
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; | ||
/** | ||
* Contains interfaces for use with the RDSDataService client. | ||
*/ | ||
export import Types = RDSDataService; | ||
export import Types = RDSDataService; | ||
} | ||
export = RDSDataService; |
@@ -9,8 +9,8 @@ // Type definitions for non-npm package aws-sdk2-types 0.0 | ||
import {GlobalConfigInstance} from './lib/config'; | ||
import { GlobalConfigInstance } from './lib/config'; | ||
export * from './clients/all'; | ||
export * from './lib/core'; | ||
export * from './clients/all'; | ||
export var config: GlobalConfigInstance | ||
export var config: GlobalConfigInstance; | ||
export as namespace AWS; |
import * as AWS from '../clients/all'; | ||
export abstract class ConfigurationServicePlaceholders { | ||
dynamodb?: AWS.DynamoDB.Types.ClientConfiguration; | ||
rdsdataservice?: AWS.RDSDataService.Types.ClientConfiguration; | ||
s3?: AWS.S3.Types.ClientConfiguration; | ||
ses?: AWS.SES.Types.ClientConfiguration; | ||
ssm?: AWS.SSM.Types.ClientConfiguration; | ||
dynamodb?: AWS.DynamoDB.Types.ClientConfiguration; | ||
rdsdataservice?: AWS.RDSDataService.Types.ClientConfiguration; | ||
s3?: AWS.S3.Types.ClientConfiguration; | ||
ses?: AWS.SES.Types.ClientConfiguration; | ||
ssm?: AWS.SSM.Types.ClientConfiguration; | ||
} | ||
export interface ConfigurationServiceApiVersions { | ||
dynamodb?: AWS.DynamoDB.Types.apiVersion; | ||
rdsdataservice?: AWS.RDSDataService.Types.apiVersion; | ||
s3?: AWS.S3.Types.apiVersion; | ||
ses?: AWS.SES.Types.apiVersion; | ||
ssm?: AWS.SSM.Types.apiVersion; | ||
dynamodb?: AWS.DynamoDB.Types.apiVersion; | ||
rdsdataservice?: AWS.RDSDataService.Types.apiVersion; | ||
s3?: AWS.S3.Types.apiVersion; | ||
ses?: AWS.SES.Types.apiVersion; | ||
ssm?: AWS.SSM.Types.apiVersion; | ||
} |
@@ -1,7 +0,7 @@ | ||
import {ConfigBase} from './config-base'; | ||
import { ConfigBase } from './config-base'; | ||
export interface UseDualstackConfigOptions { | ||
/** | ||
* Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. | ||
* In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. | ||
* Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. | ||
* In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. | ||
* Note, however, that currently on Windows, the IPv4 address will be preferred. | ||
@@ -8,0 +8,0 @@ * @deprecated Use {@link ConfigBase.useDualstackEndpoint} |
@@ -1,10 +0,10 @@ | ||
import {Agent as httpAgent} from 'http'; | ||
import {Agent as httpsAgent} from 'https'; | ||
import {AWSError} from './error'; | ||
import {Credentials, CredentialsOptions} from './credentials'; | ||
import {CredentialProviderChain} from './credentials/credential_provider_chain'; | ||
import {Token} from './token'; | ||
import {TokenProviderChain} from './token/token_provider_chain'; | ||
import { Agent as httpAgent } from 'http'; | ||
import { Agent as httpsAgent } from 'https'; | ||
import { Credentials, CredentialsOptions } from './credentials'; | ||
import { CredentialProviderChain } from './credentials/credential_provider_chain'; | ||
import { AWSError } from './error'; | ||
import { Token } from './token'; | ||
import { TokenProviderChain } from './token/token_provider_chain'; | ||
export class ConfigBase extends ConfigurationOptions{ | ||
export class ConfigBase extends ConfigurationOptions { | ||
constructor(options?: ConfigurationOptions); | ||
@@ -14,7 +14,9 @@ /** | ||
*/ | ||
getCredentials(callback: (err: AWSError|null, credentials: Credentials|CredentialsOptions|null) => void): void; | ||
getCredentials( | ||
callback: (err: AWSError | null, credentials: Credentials | CredentialsOptions | null) => void, | ||
): void; | ||
/** | ||
* Loads token from the token object. | ||
*/ | ||
getToken(callback: (err: AWSError|null, token: Token|null) => void): void; | ||
getToken(callback: (err: AWSError | null, token: Token | null) => void): void; | ||
/** | ||
@@ -34,3 +36,3 @@ * Loads configuration data from a JSON file into this config object. | ||
*/ | ||
update(options: ConfigurationOptions & {[key: string]: any}, allowUnknownKeys: true): void; | ||
update(options: ConfigurationOptions & { [key: string]: any }, allowUnknownKeys: true): void; | ||
/** | ||
@@ -92,3 +94,3 @@ * Updates the current configuration object with new options. | ||
export interface Logger { | ||
write?: (chunk: any, encoding?: string, callback?: () => void) => void | ||
write?: (chunk: any, encoding?: string, callback?: () => void) => void; | ||
log?: (...messages: any[]) => void; | ||
@@ -102,15 +104,15 @@ warn?: (...message: any[]) => void; | ||
*/ | ||
min?: boolean | ||
min?: boolean; | ||
/** | ||
* Validates that a value meets the max constraint. | ||
*/ | ||
max?: boolean | ||
max?: boolean; | ||
/** | ||
* Validates that a string value matches a regular expression. | ||
*/ | ||
pattern?: boolean | ||
pattern?: boolean; | ||
/** | ||
* Validates that a string value matches one of the allowable enum values. | ||
*/ | ||
enum?: boolean | ||
enum?: boolean; | ||
} | ||
@@ -122,3 +124,3 @@ export interface RetryDelayOptions { | ||
*/ | ||
base?: number | ||
base?: number; | ||
/** | ||
@@ -128,3 +130,3 @@ * A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. | ||
*/ | ||
customBackoff?: (retryCount: number, err?: Error) => number | ||
customBackoff?: (retryCount: number, err?: Error) => number; | ||
} | ||
@@ -136,3 +138,2 @@ | ||
export abstract class ConfigurationOptions { | ||
/** | ||
@@ -142,11 +143,11 @@ * Whether to compute checksums for payload bodies when the service accepts it. | ||
*/ | ||
computeChecksums?: boolean | ||
computeChecksums?: boolean; | ||
/** | ||
* Whether types are converted when parsing response data. | ||
*/ | ||
convertResponseTypes?: boolean | ||
convertResponseTypes?: boolean; | ||
/** | ||
* Whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. | ||
*/ | ||
correctClockSkew?: boolean | ||
correctClockSkew?: boolean; | ||
/** | ||
@@ -157,19 +158,19 @@ * Sets a custom User-Agent string. | ||
*/ | ||
customUserAgent?: string | ||
customUserAgent?: string; | ||
/** | ||
* The AWS credentials to sign requests with. | ||
*/ | ||
credentials?: Credentials|CredentialsOptions|null | ||
credentials?: Credentials | CredentialsOptions | null; | ||
/** | ||
* The provider chain used to resolve credentials if no static credentials property is set. | ||
*/ | ||
credentialProvider?: CredentialProviderChain | ||
credentialProvider?: CredentialProviderChain; | ||
/** | ||
* The Token to authenticate requests with. | ||
*/ | ||
token?: Token|null | ||
token?: Token | null; | ||
/** | ||
* The provider chain used to resolve token if no static token property is set. | ||
*/ | ||
tokenProvider?: TokenProviderChain | ||
tokenProvider?: TokenProviderChain; | ||
/** | ||
@@ -180,3 +181,3 @@ * AWS access key ID. | ||
*/ | ||
accessKeyId?: string | ||
accessKeyId?: string; | ||
/** | ||
@@ -187,3 +188,3 @@ * AWS secret access key. | ||
*/ | ||
secretAccessKey?: string | ||
secretAccessKey?: string; | ||
/** | ||
@@ -194,19 +195,19 @@ * AWS session token. | ||
*/ | ||
sessionToken?: string | ||
sessionToken?: string; | ||
/** | ||
* A set of options to pass to the low-level HTTP request. | ||
*/ | ||
httpOptions?: HTTPOptions | ||
httpOptions?: HTTPOptions; | ||
/** | ||
* An object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests. | ||
*/ | ||
logger?: Logger | ||
logger?: Logger; | ||
/** | ||
* The maximum amount of redirects to follow for a service request. | ||
*/ | ||
maxRedirects?: number | ||
maxRedirects?: number; | ||
/** | ||
* The maximum amount of retries to perform for a service request. | ||
*/ | ||
maxRetries?: number | ||
maxRetries?: number; | ||
/** | ||
@@ -217,11 +218,11 @@ * Returns whether input parameters should be validated against the operation description before sending the request. | ||
*/ | ||
paramValidation?: ParamValidation|boolean | ||
paramValidation?: ParamValidation | boolean; | ||
/** | ||
* The region to send service requests to. | ||
*/ | ||
region?: string | ||
region?: string; | ||
/** | ||
* Returns A set of options to configure the retry delay on retryable errors. | ||
*/ | ||
retryDelayOptions?: RetryDelayOptions | ||
retryDelayOptions?: RetryDelayOptions; | ||
/** | ||
@@ -231,11 +232,11 @@ * Whether the provided endpoint addresses an individual bucket. | ||
*/ | ||
s3BucketEndpoint?: boolean | ||
s3BucketEndpoint?: boolean; | ||
/** | ||
* Whether to disable S3 body signing when using signature version v4. | ||
*/ | ||
s3DisableBodySigning?: boolean | ||
s3DisableBodySigning?: boolean; | ||
/** | ||
* Whether to force path style URLs for S3 objects. | ||
*/ | ||
s3ForcePathStyle?: boolean | ||
s3ForcePathStyle?: boolean; | ||
/** | ||
@@ -246,3 +247,3 @@ * When region is set to 'us-east-1', whether to send s3 request to global endpoints | ||
*/ | ||
s3UsEast1RegionalEndpoint?: "regional"|"legacy" | ||
s3UsEast1RegionalEndpoint?: 'regional' | 'legacy'; | ||
/** | ||
@@ -253,7 +254,7 @@ * Whether to override the request region with the region inferred | ||
*/ | ||
s3UseArnRegion?: boolean | ||
s3UseArnRegion?: boolean; | ||
/** | ||
* Whether the signature to sign requests with (overriding the API configuration) is cached. | ||
*/ | ||
signatureCache?: boolean | ||
signatureCache?: boolean; | ||
/** | ||
@@ -263,15 +264,15 @@ * The signature version to sign requests with (overriding the API configuration). | ||
*/ | ||
signatureVersion?: "v2"|"v3"|"v4"|string | ||
signatureVersion?: 'v2' | 'v3' | 'v4' | string; | ||
/** | ||
* Whether SSL is enabled for requests. | ||
*/ | ||
sslEnabled?: boolean | ||
sslEnabled?: boolean; | ||
/** | ||
* An offset value in milliseconds to apply to all signing times. | ||
*/ | ||
systemClockOffset?: number | ||
systemClockOffset?: number; | ||
/** | ||
* Whether to use the Accelerate endpoint with the S3 service. | ||
*/ | ||
useAccelerateEndpoint?: boolean | ||
useAccelerateEndpoint?: boolean; | ||
/** | ||
@@ -283,3 +284,3 @@ * Whether to validate the CRC32 checksum of HTTP response bodies returned | ||
/** | ||
* Whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by | ||
* Whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by | ||
* the service. | ||
@@ -300,5 +301,5 @@ */ | ||
* Whether to send sts request to global endpoints or | ||
* regional endpoints. | ||
* regional endpoints. | ||
*/ | ||
stsRegionalEndpoints?: "legacy"|"regional"; | ||
stsRegionalEndpoints?: 'legacy' | 'regional'; | ||
/** | ||
@@ -305,0 +306,0 @@ * Enables FIPS compatible endpoints. |
@@ -1,3 +0,3 @@ | ||
import {ConfigurationServicePlaceholders, ConfigurationServiceApiVersions} from './config_service_placeholders'; | ||
import {ConfigBase, ConfigurationOptions} from './config-base'; | ||
import { ConfigBase, ConfigurationOptions } from './config-base'; | ||
import { ConfigurationServiceApiVersions, ConfigurationServicePlaceholders } from './config_service_placeholders'; | ||
@@ -24,3 +24,6 @@ export class Config extends ConfigBase { | ||
*/ | ||
update(options: ConfigurationOptions & ConfigurationServicePlaceholders & APIVersions & {[key: string]: any}, allowUnknownKeys: true): void; | ||
update( | ||
options: ConfigurationOptions & ConfigurationServicePlaceholders & APIVersions & { [key: string]: any }, | ||
allowUnknownKeys: true, | ||
): void; | ||
/** | ||
@@ -32,3 +35,6 @@ * Updates the current configuration object with new options. | ||
*/ | ||
update(options: ConfigurationOptions & ConfigurationServicePlaceholders & APIVersions, allowUnknownKeys?: false): void; | ||
update( | ||
options: ConfigurationOptions & ConfigurationServicePlaceholders & APIVersions, | ||
allowUnknownKeys?: false, | ||
): void; | ||
} | ||
@@ -38,3 +44,2 @@ | ||
export interface APIVersions { | ||
@@ -44,3 +49,3 @@ /** | ||
*/ | ||
apiVersion?: "latest"|string; | ||
apiVersion?: 'latest' | string; | ||
/** | ||
@@ -53,2 +58,2 @@ * A map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version. | ||
// for backwards compatible client generation | ||
export { ConfigBase } from "./config-base"; | ||
export { ConfigBase } from './config-base'; |
@@ -1,28 +0,28 @@ | ||
export {Config} from './config'; | ||
export {HTTPOptions, ConfigurationOptions} from './config-base'; | ||
export {Credentials} from './credentials'; | ||
export {CredentialProviderChain} from './credentials/credential_provider_chain'; | ||
export {EC2MetadataCredentials} from './credentials/ec2_metadata_credentials'; | ||
export {RemoteCredentials} from './credentials/remote_credentials'; | ||
export {ECSCredentials} from './credentials/ecs_credentials'; | ||
export {EnvironmentCredentials} from './credentials/environment_credentials'; | ||
export {FileSystemCredentials} from './credentials/file_system_credentials'; | ||
export {SAMLCredentials} from './credentials/saml_credentials'; | ||
export {SharedIniFileCredentials} from './credentials/shared_ini_file_credentials'; | ||
export {ProcessCredentials} from './credentials/process_credentials'; | ||
export {TokenFileWebIdentityCredentials} from './credentials/token_file_web_identity_credentials'; | ||
export {Token} from './token'; | ||
export {StaticTokenProvider} from './token/static_token_provider'; | ||
export {SSOTokenProvider} from './token/sso_token_provider'; | ||
export {TokenProviderChain} from './token/token_provider_chain'; | ||
export {Endpoint} from './endpoint'; | ||
export {EventListeners} from './event_listeners'; | ||
export {HttpRequest} from './http_request'; | ||
export {HttpResponse} from './http_response'; | ||
export {MetadataService} from './metadata_service'; | ||
export {Request} from './request'; | ||
export {Response} from './response'; | ||
export {Service} from './service'; | ||
export {AWSError} from './error'; | ||
export {IniLoader} from './shared-ini/ini-loader'; | ||
export {DocumentType} from './model'; | ||
export { Config } from './config'; | ||
export { ConfigurationOptions, HTTPOptions } from './config-base'; | ||
export { Credentials } from './credentials'; | ||
export { CredentialProviderChain } from './credentials/credential_provider_chain'; | ||
export { EC2MetadataCredentials } from './credentials/ec2_metadata_credentials'; | ||
export { ECSCredentials } from './credentials/ecs_credentials'; | ||
export { EnvironmentCredentials } from './credentials/environment_credentials'; | ||
export { FileSystemCredentials } from './credentials/file_system_credentials'; | ||
export { ProcessCredentials } from './credentials/process_credentials'; | ||
export { RemoteCredentials } from './credentials/remote_credentials'; | ||
export { SAMLCredentials } from './credentials/saml_credentials'; | ||
export { SharedIniFileCredentials } from './credentials/shared_ini_file_credentials'; | ||
export { TokenFileWebIdentityCredentials } from './credentials/token_file_web_identity_credentials'; | ||
export { Endpoint } from './endpoint'; | ||
export { AWSError } from './error'; | ||
export { EventListeners } from './event_listeners'; | ||
export { HttpRequest } from './http_request'; | ||
export { HttpResponse } from './http_response'; | ||
export { MetadataService } from './metadata_service'; | ||
export { DocumentType } from './model'; | ||
export { Request } from './request'; | ||
export { Response } from './response'; | ||
export { Service } from './service'; | ||
export { IniLoader } from './shared-ini/ini-loader'; | ||
export { Token } from './token'; | ||
export { SSOTokenProvider } from './token/sso_token_provider'; | ||
export { StaticTokenProvider } from './token/static_token_provider'; | ||
export { TokenProviderChain } from './token/token_provider_chain'; |
@@ -1,2 +0,2 @@ | ||
import {AWSError} from './error'; | ||
import { AWSError } from './error'; | ||
export class Credentials { | ||
@@ -77,11 +77,11 @@ /** | ||
*/ | ||
accessKeyId: string | ||
accessKeyId: string; | ||
/** | ||
* AWS secret access key. | ||
*/ | ||
secretAccessKey: string | ||
secretAccessKey: string; | ||
/** | ||
* AWS session token. | ||
*/ | ||
sessionToken?: string | ||
sessionToken?: string; | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Credentials} from '../credentials'; | ||
import {AWSError} from '../error'; | ||
import { Credentials } from '../credentials'; | ||
import { AWSError } from '../error'; | ||
export class CredentialProviderChain { | ||
@@ -7,7 +7,7 @@ /** | ||
*/ | ||
constructor(providers?: provider[]) | ||
constructor(providers?: provider[]); | ||
/** | ||
* Resolves the provider chain by searching for the first set of credentials in providers. | ||
*/ | ||
resolve(callback:(err: AWSError|null, credentials?: Credentials) => void): CredentialProviderChain; | ||
resolve(callback: (err: AWSError | null, credentials?: Credentials) => void): CredentialProviderChain; | ||
/** | ||
@@ -20,7 +20,7 @@ * Return a Promise on resolve() function | ||
*/ | ||
providers: Array<Credentials|provider>; | ||
providers: Array<Credentials | provider>; | ||
static defaultProviders: provider[] | ||
static defaultProviders: provider[]; | ||
} | ||
type provider = () => Credentials; |
@@ -1,3 +0,3 @@ | ||
import {Credentials} from '../credentials'; | ||
import {Logger} from '../config-base'; | ||
import { Logger } from '../config-base'; | ||
import { Credentials } from '../credentials'; | ||
@@ -23,10 +23,10 @@ export class EC2MetadataCredentials extends Credentials { | ||
*/ | ||
timeout?: number | ||
timeout?: number; | ||
/** | ||
* Connection timeout in milliseconds. | ||
*/ | ||
connectTimeout?: number | ||
} | ||
maxRetries?: number | ||
logger?: Logger | ||
* Connection timeout in milliseconds. | ||
*/ | ||
connectTimeout?: number; | ||
}; | ||
maxRetries?: number; | ||
logger?: Logger; | ||
} |
@@ -1,17 +0,17 @@ | ||
import {RemoteCredentials} from './remote_credentials'; | ||
import { RemoteCredentials } from './remote_credentials'; | ||
export class ECSCredentials extends RemoteCredentials { | ||
/** | ||
* Represents credentials received. | ||
* @param {object} options - Override the default (1s) timeout period. | ||
*/ | ||
constructor(options?: ECSCredentialsOptions); | ||
} | ||
interface ECSCredentialsOptions { | ||
httpOptions?: { | ||
/** | ||
* Represents credentials received. | ||
* @param {object} options - Override the default (1s) timeout period. | ||
* Timeout in milliseconds. | ||
*/ | ||
constructor(options?: ECSCredentialsOptions); | ||
} | ||
interface ECSCredentialsOptions { | ||
httpOptions?: { | ||
/** | ||
* Timeout in milliseconds. | ||
*/ | ||
timeout?: number | ||
} | ||
maxRetries?: number | ||
} | ||
timeout?: number; | ||
}; | ||
maxRetries?: number; | ||
} |
@@ -1,2 +0,2 @@ | ||
import {Credentials} from '../credentials'; | ||
import { Credentials } from '../credentials'; | ||
export class EnvironmentCredentials extends Credentials { | ||
@@ -8,2 +8,2 @@ /** | ||
constructor(envPrefix: string); | ||
} | ||
} |
@@ -1,2 +0,2 @@ | ||
import {Credentials} from '../credentials'; | ||
import { Credentials } from '../credentials'; | ||
export class FileSystemCredentials extends Credentials { | ||
@@ -11,3 +11,3 @@ /** | ||
*/ | ||
filename: string | ||
} | ||
filename: string; | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Credentials} from '../credentials'; | ||
import {HTTPOptions} from '../config-base'; | ||
import { HTTPOptions } from '../config-base'; | ||
import { Credentials } from '../credentials'; | ||
export class ProcessCredentials extends Credentials { | ||
@@ -11,5 +11,5 @@ /** | ||
interface ProcessCredentialsOptions { | ||
profile?: string | ||
filename?: string | ||
httpOptions?: HTTPOptions | ||
profile?: string; | ||
filename?: string; | ||
httpOptions?: HTTPOptions; | ||
} |
@@ -1,17 +0,17 @@ | ||
import {Credentials} from '../credentials'; | ||
import { Credentials } from '../credentials'; | ||
export class RemoteCredentials extends Credentials { | ||
/** | ||
* Represents credentials received. | ||
* @param {object} options - Override the default (1s) timeout period. | ||
*/ | ||
constructor(options?: RemoteCredentialsOptions); | ||
} | ||
interface RemoteCredentialsOptions { | ||
httpOptions?: { | ||
/** | ||
* Represents credentials received. | ||
* @param {object} options - Override the default (1s) timeout period. | ||
* Timeout in milliseconds. | ||
*/ | ||
constructor(options?: RemoteCredentialsOptions); | ||
} | ||
interface RemoteCredentialsOptions { | ||
httpOptions?: { | ||
/** | ||
* Timeout in milliseconds. | ||
*/ | ||
timeout?: number | ||
} | ||
maxRetries?: number | ||
} | ||
timeout?: number; | ||
}; | ||
maxRetries?: number; | ||
} |
@@ -1,34 +0,34 @@ | ||
import {Credentials} from '../credentials'; | ||
import { Credentials } from '../credentials'; | ||
export class SAMLCredentials extends Credentials { | ||
/** | ||
* Creates a new credentials object. | ||
* @param {object} params - The map of params passed to AWS.STS.assumeRoleWithSAML(). | ||
*/ | ||
constructor(params: SAMLCredentialsParams); | ||
params: SAMLCredentialsParams | ||
} | ||
interface SAMLCredentialsParams { | ||
/** | ||
* The Amazon Resource Name (ARN) of the role that the caller is assuming. | ||
*/ | ||
RoleArn: string | ||
/** | ||
* The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. | ||
*/ | ||
PrincipalArn: string | ||
/** | ||
* The base-64 encoded SAML authentication response provided by the IdP. | ||
*/ | ||
SAMLAssertion: string | ||
/** | ||
* An IAM policy in JSON format. | ||
* The policy plain text must be 2048 bytes or shorter. | ||
*/ | ||
Policy?: string | ||
/** | ||
* The duration, in seconds, of the role session. | ||
* The minimum duration is 15 minutes. | ||
* The maximum duration is 12 hours. | ||
*/ | ||
DurationSeconds?: number | ||
} | ||
/** | ||
* Creates a new credentials object. | ||
* @param {object} params - The map of params passed to AWS.STS.assumeRoleWithSAML(). | ||
*/ | ||
constructor(params: SAMLCredentialsParams); | ||
params: SAMLCredentialsParams; | ||
} | ||
interface SAMLCredentialsParams { | ||
/** | ||
* The Amazon Resource Name (ARN) of the role that the caller is assuming. | ||
*/ | ||
RoleArn: string; | ||
/** | ||
* The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. | ||
*/ | ||
PrincipalArn: string; | ||
/** | ||
* The base-64 encoded SAML authentication response provided by the IdP. | ||
*/ | ||
SAMLAssertion: string; | ||
/** | ||
* An IAM policy in JSON format. | ||
* The policy plain text must be 2048 bytes or shorter. | ||
*/ | ||
Policy?: string; | ||
/** | ||
* The duration, in seconds, of the role session. | ||
* The minimum duration is 15 minutes. | ||
* The maximum duration is 12 hours. | ||
*/ | ||
DurationSeconds?: number; | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Credentials} from '../credentials'; | ||
import {HTTPOptions} from '../config-base'; | ||
import { HTTPOptions } from '../config-base'; | ||
import { Credentials } from '../credentials'; | ||
export class SharedIniFileCredentials extends Credentials { | ||
@@ -11,8 +11,8 @@ /** | ||
interface SharedIniFileCredentialsOptions { | ||
profile?: string | ||
filename?: string | ||
disableAssumeRole?: boolean | ||
tokenCodeFn?: (mfaSerial: string, callback: (err?: Error, token?: string) => void) => void | ||
httpOptions?: HTTPOptions | ||
callback?: (err?: Error) => void | ||
profile?: string; | ||
filename?: string; | ||
disableAssumeRole?: boolean; | ||
tokenCodeFn?: (mfaSerial: string, callback: (err?: Error, token?: string) => void) => void; | ||
httpOptions?: HTTPOptions; | ||
callback?: (err?: Error) => void; | ||
} |
@@ -1,4 +0,4 @@ | ||
import {Credentials} from '../credentials'; | ||
import {AWSError} from '../error'; | ||
import {ConfigurationOptions} from '../config-base'; | ||
import { ConfigurationOptions } from '../config-base'; | ||
import { Credentials } from '../credentials'; | ||
import { AWSError } from '../error'; | ||
export class TokenFileWebIdentityCredentials extends Credentials { | ||
@@ -5,0 +5,0 @@ /** |
@@ -6,8 +6,8 @@ import DynamoDB = require('../../clients/dynamodb'); | ||
data: any, | ||
options?: Converter.ConverterOptions | ||
options?: Converter.ConverterOptions, | ||
): DynamoDB.AttributeValue; | ||
static marshall( | ||
data: {[key: string]: any}, | ||
options?: Converter.ConverterOptions | ||
data: { [key: string]: any }, | ||
options?: Converter.ConverterOptions, | ||
): DynamoDB.AttributeMap; | ||
@@ -17,3 +17,3 @@ | ||
data: DynamoDB.AttributeValue, | ||
options?: Converter.ConverterOptions | ||
options?: Converter.ConverterOptions, | ||
): any; | ||
@@ -23,4 +23,4 @@ | ||
data: DynamoDB.AttributeMap, | ||
options?: Converter.ConverterOptions | ||
): {[key: string]: any}; | ||
options?: Converter.ConverterOptions, | ||
): { [key: string]: any }; | ||
} | ||
@@ -27,0 +27,0 @@ |
@@ -27,2 +27,2 @@ export class Endpoint { | ||
protocol: string; | ||
} | ||
} |
@@ -52,3 +52,3 @@ /** | ||
*/ | ||
originalError?: Error | ||
} | ||
originalError?: Error; | ||
}; |
@@ -14,3 +14,3 @@ /** | ||
/** | ||
* A request listener that reads data from the HTTP connection in order to build the response data. Handles the 'httpData' Request event. | ||
* A request listener that reads data from the HTTP connection in order to build the response data. Handles the 'httpData' Request event. | ||
* Remove this handler if you are overriding the 'httpData' event and do not want extra data processing and buffering overhead. | ||
@@ -34,4 +34,4 @@ */ | ||
*/ | ||
export function VALIDATE_REGION():void; | ||
export function VALIDATE_REGION(): void; | ||
} | ||
} | ||
} |
export interface StreamingEventStream<Events> extends NodeJS.ReadableStream { | ||
on(event: "data", listener: (event: Events) => void): this; | ||
on(event: 'data', listener: (event: Events) => void): this; | ||
on(event: string, listener: Function): this; | ||
} | ||
export type EventStream<Events> = StreamingEventStream<Events> | Events[]; | ||
export type EventStream<Events> = StreamingEventStream<Events> | Events[]; |
@@ -1,2 +0,2 @@ | ||
import {Endpoint} from './endpoint'; | ||
import { Endpoint } from './endpoint'; | ||
/** | ||
@@ -31,3 +31,3 @@ * The low level HTTP request object, encapsulating all HTTP header and body data sent by a service request. | ||
[key: string]: string; | ||
} | ||
}; | ||
/** | ||
@@ -34,0 +34,0 @@ * The HTTP method of the request. |
@@ -10,7 +10,7 @@ import * as stream from 'stream'; | ||
*/ | ||
createUnbufferedStream(): stream.Readable|XMLHttpRequest | ||
createUnbufferedStream(): stream.Readable | XMLHttpRequest; | ||
/** | ||
* The response body payload. | ||
*/ | ||
body: string|Buffer|Uint8Array; | ||
body: string | Buffer | Uint8Array; | ||
/** | ||
@@ -21,3 +21,3 @@ * A map of response header keys and their respective values. | ||
[key: string]: string; | ||
} | ||
}; | ||
/** | ||
@@ -24,0 +24,0 @@ * The HTTP status code of the response (e.g., 200, 404). |
@@ -1,2 +0,2 @@ | ||
import {AWSError} from './error'; | ||
import { AWSError } from './error'; | ||
/** | ||
@@ -16,4 +16,4 @@ * Represents a metadata service available on EC2 instances. Using the request() method, you can receieve metadata about any available resource on the metadata service. | ||
path: string, | ||
options: {method?: string, headers?: {[key: string]: String} }, | ||
callback: (err: AWSError, data: string) => void | ||
options: { method?: string; headers?: { [key: string]: String } }, | ||
callback: (err: AWSError, data: string) => void, | ||
): void; | ||
@@ -23,3 +23,3 @@ /** | ||
*/ | ||
static host: string | ||
static host: string; | ||
/** | ||
@@ -33,3 +33,3 @@ * A map of options to pass to the underlying HTTP request. | ||
timeout: number; | ||
} | ||
}; | ||
} | ||
@@ -50,3 +50,3 @@ | ||
timeout?: number; | ||
} | ||
}; | ||
/** | ||
@@ -59,3 +59,3 @@ * the maximum number of retries to perform for timeout errors. | ||
*/ | ||
retryDelayOptions?: any | ||
retryDelayOptions?: any; | ||
} |
import * as stream from 'stream'; | ||
import {Service} from './service'; | ||
import {Response} from './response'; | ||
import {HttpRequest} from './http_request'; | ||
import {AWSError} from './error'; | ||
import { AWSError } from './error'; | ||
import { HttpRequest } from './http_request'; | ||
import { Response } from './response'; | ||
import { Service } from './service'; | ||
export class Request<D, E> { | ||
@@ -57,3 +57,3 @@ /** | ||
*/ | ||
on(event: "validate", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'validate', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -66,3 +66,3 @@ * Adds a listener that is triggered when the request payload is being built. | ||
*/ | ||
on(event: "build", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'build', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -75,3 +75,3 @@ * Adds a listener that is triggered when a request is being signed. | ||
*/ | ||
on(event: "sign", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'sign', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -84,3 +84,3 @@ * Adds a listener that is triggered when a request is ready to be sent. | ||
*/ | ||
on(event: "send", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'send', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -93,3 +93,3 @@ * Adds a listener that is triggered when a request failed and might need to be retried or redirected. | ||
*/ | ||
on(event: "retry", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'retry', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -102,3 +102,3 @@ * Adds a listener that is triggered on all non-2xx requests so that listeners can extract error details from the response body. | ||
*/ | ||
on(event: "extractError", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'extractError', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -111,3 +111,3 @@ * Adds a listener that is triggered in successful requests to allow listeners to de-serialize the response body into response.data. | ||
*/ | ||
on(event: "extractData", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'extractData', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -120,3 +120,3 @@ * Adds a listener that is triggered when the request completed successfully. | ||
*/ | ||
on(event: "success", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'success', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -129,3 +129,3 @@ * Adds a listener that is triggered when an error occurs at any point during the request. | ||
*/ | ||
on(event: "error", listener: (err: AWSError, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'error', listener: (err: AWSError, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -138,3 +138,3 @@ * Adds a listener that is triggered whenever a request cycle completes. | ||
*/ | ||
on(event: "complete", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'complete', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -147,3 +147,12 @@ * Adds a listener that is triggered when headers are sent by the remote server. | ||
*/ | ||
on(event: "httpHeaders", listener: (statusCode: number, headers: {[key: string]: string}, response: Response<D, E>, statusMessage: string) => void, prepend?: boolean): Request<D, E>; | ||
on( | ||
event: 'httpHeaders', | ||
listener: ( | ||
statusCode: number, | ||
headers: { [key: string]: string }, | ||
response: Response<D, E>, | ||
statusMessage: string, | ||
) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -156,3 +165,7 @@ * Adds a listener that is triggered when data is sent by the remote server. | ||
*/ | ||
on(event: "httpData", listener: (chunk: Buffer|Uint8Array, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on( | ||
event: 'httpData', | ||
listener: (chunk: Buffer | Uint8Array, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -165,3 +178,7 @@ * Adds a listener that is triggered when the HTTP request has uploaded more data. | ||
*/ | ||
on(event: "httpUploadProgress", listener: (progress: Progress, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on( | ||
event: 'httpUploadProgress', | ||
listener: (progress: Progress, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -174,3 +191,7 @@ * Adds a listener that is triggered when the HTTP request has downloaded more data. | ||
*/ | ||
on(event: "httpDownloadProgress", listener: (progress: Progress, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on( | ||
event: 'httpDownloadProgress', | ||
listener: (progress: Progress, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -183,3 +204,3 @@ * Adds a listener that is triggered when the HTTP request failed. | ||
*/ | ||
on(event: "httpError", listener: (err: Error, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'httpError', listener: (err: Error, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -192,3 +213,3 @@ * Adds a listener that is triggered when the server is finished sending data. | ||
*/ | ||
on(event: "httpDone", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
on(event: 'httpDone', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -209,3 +230,3 @@ * Adds a listener that is triggered when a request emits the specified event. | ||
*/ | ||
onAsync(event: "validate", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'validate', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -218,3 +239,3 @@ * Adds a listener that is triggered when the request payload is being built. | ||
*/ | ||
onAsync(event: "build", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'build', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -227,3 +248,3 @@ * Adds a listener that is triggered when a request is being signed. | ||
*/ | ||
onAsync(event: "sign", listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'sign', listener: (request: Request<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -236,3 +257,3 @@ * Adds a listener that is triggered when a request is ready to be sent. | ||
*/ | ||
onAsync(event: "send", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'send', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -245,3 +266,3 @@ * Adds a listener that is triggered when a request failed and might need to be retried or redirected. | ||
*/ | ||
onAsync(event: "retry", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'retry', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -254,3 +275,3 @@ * Adds a listener that is triggered on all non-2xx requests so that listeners can extract error details from the response body. | ||
*/ | ||
onAsync(event: "extractError", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'extractError', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -263,3 +284,3 @@ * Adds a listener that is triggered in successful requests to allow listeners to de-serialize the response body into response.data. | ||
*/ | ||
onAsync(event: "extractData", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'extractData', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -272,3 +293,3 @@ * Adds a listener that is triggered when the request completed successfully. | ||
*/ | ||
onAsync(event: "success", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'success', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -281,3 +302,7 @@ * Adds a listener that is triggered when an error occurs at any point during the request. | ||
*/ | ||
onAsync(event: "error", listener: (err: AWSError, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'error', | ||
listener: (err: AWSError, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -290,3 +315,3 @@ * Adds a listener that is triggered whenever a request cycle completes. | ||
*/ | ||
onAsync(event: "complete", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'complete', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
@@ -299,3 +324,12 @@ * Adds a listener that is triggered when headers are sent by the remote server. | ||
*/ | ||
onAsync(event: "httpHeaders", listener: (statusCode: number, headers: {[key: string]: string}, response: Response<D, E>, statusMessage: string) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'httpHeaders', | ||
listener: ( | ||
statusCode: number, | ||
headers: { [key: string]: string }, | ||
response: Response<D, E>, | ||
statusMessage: string, | ||
) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -308,3 +342,7 @@ * Adds a listener that is triggered when data is sent by the remote server. | ||
*/ | ||
onAsync(event: "httpData", listener: (chunk: Buffer|Uint8Array, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'httpData', | ||
listener: (chunk: Buffer | Uint8Array, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -317,3 +355,7 @@ * Adds a listener that is triggered when the HTTP request has uploaded more data. | ||
*/ | ||
onAsync(event: "httpUploadProgress", listener: (progress: Progress, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'httpUploadProgress', | ||
listener: (progress: Progress, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -326,3 +368,7 @@ * Adds a listener that is triggered when the HTTP request has downloaded more data. | ||
*/ | ||
onAsync(event: "httpDownloadProgress", listener: (progress: Progress, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'httpDownloadProgress', | ||
listener: (progress: Progress, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -335,3 +381,7 @@ * Adds a listener that is triggered when the HTTP request failed. | ||
*/ | ||
onAsync(event: "httpError", listener: (err: Error, response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync( | ||
event: 'httpError', | ||
listener: (err: Error, response: Response<D, E>) => void, | ||
prepend?: boolean, | ||
): Request<D, E>; | ||
/** | ||
@@ -344,7 +394,7 @@ * Adds a listener that is triggered when the server is finished sending data. | ||
*/ | ||
onAsync(event: "httpDone", listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
onAsync(event: 'httpDone', listener: (response: Response<D, E>) => void, prepend?: boolean): Request<D, E>; | ||
/** | ||
* Returns a 'thenable' promise. | ||
*/ | ||
promise(): Promise<PromiseResult<D, E>> | ||
promise(): Promise<PromiseResult<D, E>>; | ||
/** | ||
@@ -358,6 +408,5 @@ * The time that the request started. | ||
httpRequest: HttpRequest; | ||
} | ||
export type PromiseResult<D, E> = D & {$response: Response<D, E>}; | ||
export type PromiseResult<D, E> = D & { $response: Response<D, E> }; | ||
@@ -364,0 +413,0 @@ export interface Progress { |
@@ -1,38 +0,38 @@ | ||
import {HttpResponse} from './http_response'; | ||
import {Request} from './request'; | ||
import { HttpResponse } from './http_response'; | ||
import { Request } from './request'; | ||
export class Response<D, E> { | ||
/** | ||
* Whether more pages of data can be returned by further requests. | ||
*/ | ||
hasNextPage(): boolean; | ||
/** | ||
* Creates a new request for the next page of response data, calling the callback with the page data if a callback is provided. | ||
*/ | ||
nextPage(callback?: (err: E, data: D) => void): Request<D, E>|void; | ||
/** | ||
* The de-serialized response data from the service. | ||
* Can be null if an error occurred. | ||
*/ | ||
data: D|void | ||
/** | ||
* A structure containing information about a service or networking error. | ||
*/ | ||
error: E|void | ||
/** | ||
* Returns the unique request ID associated with the response. | ||
* Log this value when debugging requests for AWS support. | ||
*/ | ||
requestId: string | ||
/** | ||
* The number of redirects that were followed before the request was completed. | ||
*/ | ||
redirectCount: number | ||
/** | ||
* The number of retries that were attempted before the request was completed. | ||
*/ | ||
retryCount: number | ||
/** | ||
* The raw HTTP response object containing the response headers and body information from the server. | ||
*/ | ||
httpResponse: HttpResponse; | ||
} | ||
/** | ||
* Whether more pages of data can be returned by further requests. | ||
*/ | ||
hasNextPage(): boolean; | ||
/** | ||
* Creates a new request for the next page of response data, calling the callback with the page data if a callback is provided. | ||
*/ | ||
nextPage(callback?: (err: E, data: D) => void): Request<D, E> | void; | ||
/** | ||
* The de-serialized response data from the service. | ||
* Can be null if an error occurred. | ||
*/ | ||
data: D | void; | ||
/** | ||
* A structure containing information about a service or networking error. | ||
*/ | ||
error: E | void; | ||
/** | ||
* Returns the unique request ID associated with the response. | ||
* Log this value when debugging requests for AWS support. | ||
*/ | ||
requestId: string; | ||
/** | ||
* The number of redirects that were followed before the request was completed. | ||
*/ | ||
redirectCount: number; | ||
/** | ||
* The number of retries that were attempted before the request was completed. | ||
*/ | ||
retryCount: number; | ||
/** | ||
* The raw HTTP response object containing the response headers and body information from the server. | ||
*/ | ||
httpResponse: HttpResponse; | ||
} |
@@ -1,2 +0,2 @@ | ||
import {AWSError} from '../error'; | ||
import { AWSError } from '../error'; | ||
import S3 = require('../../clients/s3'); | ||
@@ -26,7 +26,7 @@ export class ManagedUpload { | ||
*/ | ||
on(event: "httpUploadProgress", listener: (progress: ManagedUpload.Progress) => void): any; | ||
on(event: 'httpUploadProgress', listener: (progress: ManagedUpload.Progress) => void): any; | ||
/** | ||
* Default value: 10000 | ||
*/ | ||
static maxTotalParts: number | ||
static maxTotalParts: number; | ||
/** | ||
@@ -37,3 +37,3 @@ * Returns the minimum number of bytes for an individual part upload. | ||
*/ | ||
static minPartSize: number | ||
static minPartSize: number; | ||
} | ||
@@ -40,0 +40,0 @@ export namespace ManagedUpload { |
@@ -24,3 +24,3 @@ export class PresignedPost { | ||
*/ | ||
Conditions?: Array<{[key: string]: any}|[string, any, any]>; | ||
Conditions?: Array<{ [key: string]: any } | [string, any, any]>; | ||
@@ -38,3 +38,3 @@ /** | ||
*/ | ||
Fields?: {[key: string]: any}; | ||
Fields?: { [key: string]: any }; | ||
} | ||
@@ -54,3 +54,3 @@ | ||
*/ | ||
'X-Amz-Signature': string; | ||
'X-Amz-Signature': string; | ||
@@ -57,0 +57,0 @@ /** |
@@ -1,5 +0,5 @@ | ||
import {Request} from './request'; | ||
import {AWSError} from './error'; | ||
import {ConfigurationOptions, ConfigBase} from './config-base'; | ||
import {Endpoint} from './endpoint'; | ||
import { ConfigBase, ConfigurationOptions } from './config-base'; | ||
import { Endpoint } from './endpoint'; | ||
import { AWSError } from './error'; | ||
import { Request } from './request'; | ||
@@ -26,3 +26,3 @@ export interface WaiterConfiguration { | ||
* Defines a new Service class using a service identifier and list of versions including an optional set of features (functions) to apply to the class prototype. | ||
* | ||
* | ||
* @param {string} serviceIdentifier - the identifier for the service. | ||
@@ -35,14 +35,22 @@ * @param {string[]} versions - a list of versions that work with this service. | ||
* Calls an operation on a service with the given input parameters. | ||
* | ||
* | ||
* @param {string} operation - the name of the operation to call on the service. | ||
* @param {map} params - a map of input options for the operation. | ||
* @param {map} params - a map of input options for the operation. | ||
*/ | ||
makeRequest(operation: string, params?: {[key: string]: any}, callback?: (err: AWSError, data: any) => void): Request<any, AWSError>; | ||
makeRequest( | ||
operation: string, | ||
params?: { [key: string]: any }, | ||
callback?: (err: AWSError, data: any) => void, | ||
): Request<any, AWSError>; | ||
/** | ||
* Calls an operation on a service with the given input parameters, without any authentication data. | ||
* | ||
* | ||
* @param {string} operation - the name of the operation to call on the service. | ||
* @param {map} params - a map of input options for the operation. | ||
* @param {map} params - a map of input options for the operation. | ||
*/ | ||
makeUnauthenticatedRequest(operation: string, params?: {[key: string]: any}, callback?: (err: AWSError, data: any) => void): Request<any, AWSError>; | ||
makeUnauthenticatedRequest( | ||
operation: string, | ||
params?: { [key: string]: any }, | ||
callback?: (err: AWSError, data: any) => void, | ||
): Request<any, AWSError>; | ||
/** | ||
@@ -55,3 +63,7 @@ * Override this method to setup any custom request listeners for each new request to the service. | ||
*/ | ||
waitFor(state: string, params?: {[key: string]: any, $waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: any) => void): Request<any, AWSError>; | ||
waitFor( | ||
state: string, | ||
params?: { [key: string]: any; $waiter?: WaiterConfiguration }, | ||
callback?: (err: AWSError, data: any) => void, | ||
): Request<any, AWSError>; | ||
waitFor(state: string, callback?: (err: AWSError, data: any) => void): Request<any, AWSError>; | ||
@@ -74,3 +86,3 @@ | ||
/** | ||
* The endpoint URI to send requests to. The default endpoint is built from the configured region. | ||
* The endpoint URI to send requests to. The default endpoint is built from the configured region. | ||
* The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object. | ||
@@ -80,3 +92,3 @@ */ | ||
/** | ||
* An optional map of parameters to bind to every request sent by this service object. | ||
* An optional map of parameters to bind to every request sent by this service object. | ||
* For more information on bound parameters, see "Working with Services" in the Getting Started Guide. | ||
@@ -86,3 +98,3 @@ */ | ||
[key: string]: any; | ||
} | ||
}; | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Service} from '../service'; | ||
import {DocumentClient as DDBDocumentClient} from '../dynamodb/document_client'; | ||
import { DocumentClient as DDBDocumentClient } from '../dynamodb/document_client'; | ||
import { Service } from '../service'; | ||
export class DynamoDBCustomizations extends Service { | ||
@@ -9,2 +9,2 @@ /** | ||
static DocumentClient: typeof DDBDocumentClient; | ||
} | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Service} from '../service'; | ||
import {ManagedUpload} from '../s3/managed_upload'; | ||
import { ManagedUpload } from '../s3/managed_upload'; | ||
import { Service } from '../service'; | ||
import S3 = require('../../clients/s3'); | ||
@@ -25,3 +25,3 @@ | ||
params: S3.PresignedPost.Params, | ||
callback: (err: Error, data: S3.PresignedPost) => void | ||
callback: (err: Error, data: S3.PresignedPost) => void, | ||
): void; | ||
@@ -40,3 +40,7 @@ /** | ||
*/ | ||
upload(params: S3.Types.PutObjectRequest, options?: ManagedUpload.ManagedUploadOptions, callback?: (err: Error, data: ManagedUpload.SendData) => void): ManagedUpload; | ||
upload( | ||
params: S3.Types.PutObjectRequest, | ||
options?: ManagedUpload.ManagedUploadOptions, | ||
callback?: (err: Error, data: ManagedUpload.SendData) => void, | ||
): ManagedUpload; | ||
/** | ||
@@ -49,4 +53,7 @@ * Uploads an arbitrarily sized buffer, blob, or stream, using intelligent | ||
*/ | ||
upload(params: S3.Types.PutObjectRequest, callback?: (err: Error, data: ManagedUpload.SendData) => void): ManagedUpload; | ||
upload( | ||
params: S3.Types.PutObjectRequest, | ||
callback?: (err: Error, data: ManagedUpload.SendData) => void, | ||
): ManagedUpload; | ||
static ManagedUpload: typeof ManagedUpload; | ||
} |
export interface LoadFileOptions { | ||
filename?: string, | ||
isConfig?: boolean, | ||
filename?: string; | ||
isConfig?: boolean; | ||
} | ||
export interface IniFileContent { | ||
[key: string]: {[key: string]: string} | ||
[key: string]: { [key: string]: string }; | ||
} | ||
/** | ||
* Ini file loader class the same as that used in the SDK. It loads and | ||
* Ini file loader class the same as that used in the SDK. It loads and | ||
* parses config and credentials files in .ini format and cache the content | ||
* to assure files are only read once. | ||
* to assure files are only read once. | ||
* Note that calling operations on the instance instantiated from this class | ||
@@ -18,14 +18,13 @@ * won't affect the behavior of SDK since SDK uses an internal singleton of | ||
*/ | ||
export class IniLoader{ | ||
/** Remove all cached files. Used after config files are updated. */ | ||
clearCachedFiles():void; | ||
export class IniLoader { | ||
/** Remove all cached files. Used after config files are updated. */ | ||
clearCachedFiles(): void; | ||
/** | ||
* Load configurations from config/credentials files and cache them | ||
* for later use. If no file is specified it will try to load default | ||
* files. | ||
* @returns {object} object of all profile information in the file | ||
*/ | ||
loadFrom(options: LoadFileOptions): IniFileContent; | ||
} | ||
/** | ||
* Load configurations from config/credentials files and cache them | ||
* for later use. If no file is specified it will try to load default | ||
* files. | ||
* @returns {object} object of all profile information in the file | ||
*/ | ||
loadFrom(options: LoadFileOptions): IniFileContent; | ||
} |
@@ -1,2 +0,2 @@ | ||
import {AWSError} from './error'; | ||
import { AWSError } from './error'; | ||
@@ -29,74 +29,74 @@ /** | ||
export class Token { | ||
/** | ||
* Creates a Token object with a given set of token information as an options hash. | ||
* | ||
* @param {object} options - An option hash containing a set of token information. | ||
*/ | ||
constructor(options: TokenOptions); | ||
/** | ||
* Creates a Token object with a given set of token information as an options hash. | ||
* | ||
* @param {object} options - An option hash containing a set of token information. | ||
*/ | ||
constructor(options: TokenOptions); | ||
/** | ||
* Gets the existing token, refreshing it if it's are not yet loaded or have expired. | ||
* Users should call this method before using refresh(), as this will not attempt to reload | ||
* tokeb when they are already loaded into the object. | ||
* | ||
* @param {get} callback - When called with no error, the token information has been loaded into the object. | ||
*/ | ||
get(callback: (err?: AWSError) => void): void; | ||
/** | ||
* Gets the existing token, refreshing it if it's are not yet loaded or have expired. | ||
* Users should call this method before using refresh(), as this will not attempt to reload | ||
* tokeb when they are already loaded into the object. | ||
* | ||
* @param {get} callback - When called with no error, the token information has been loaded into the object. | ||
*/ | ||
get(callback: (err?: AWSError) => void): void; | ||
/** | ||
* Gets the existing token, refreshing ot if necessary, and returns | ||
* a promise that will be fulfilled immediately (if no refresh is necessary) | ||
* or when the refresh has completed. | ||
*/ | ||
getPromise(): Promise<void>; | ||
/** | ||
* Gets the existing token, refreshing ot if necessary, and returns | ||
* a promise that will be fulfilled immediately (if no refresh is necessary) | ||
* or when the refresh has completed. | ||
*/ | ||
getPromise(): Promise<void>; | ||
/** | ||
* Returns whether the token object should call refresh() | ||
*/ | ||
needsRefresh(): boolean; | ||
/** | ||
* Returns whether the token object should call refresh() | ||
*/ | ||
needsRefresh(): boolean; | ||
/** | ||
* Refreshes the token. | ||
* Users should call get() before attempting to forcibly refresh token. | ||
* | ||
* @param {function} callback - When called with no error, the token information has been loaded into the object. | ||
*/ | ||
refresh(callback: (err?: AWSError) => void): void; | ||
/** | ||
* Refreshes the token. | ||
* Users should call get() before attempting to forcibly refresh token. | ||
* | ||
* @param {function} callback - When called with no error, the token information has been loaded into the object. | ||
*/ | ||
refresh(callback: (err?: AWSError) => void): void; | ||
/** | ||
* Invokes a token refresh and returns a promise that will be fulfilled | ||
* when the refresh has completed or rejected when the refresh has failed. | ||
* Users should call get() before attempting to forcibly refresh token. | ||
*/ | ||
refreshPromise(): Promise<void>; | ||
/** | ||
* Invokes a token refresh and returns a promise that will be fulfilled | ||
* when the refresh has completed or rejected when the refresh has failed. | ||
* Users should call get() before attempting to forcibly refresh token. | ||
*/ | ||
refreshPromise(): Promise<void>; | ||
/** | ||
* The literal token string. | ||
*/ | ||
token: string; | ||
/** | ||
* Whether the token has expired and require a refresh. | ||
* Used in conjunction with expireTime. | ||
*/ | ||
expired: boolean; | ||
/** | ||
* The literal token string. | ||
*/ | ||
token: string; | ||
/** | ||
* Time when token should be considered expired. | ||
* Used in conjunction with expired. | ||
*/ | ||
expireTime: Date; | ||
static expiryWindow: number; | ||
/** | ||
* Whether the token has expired and require a refresh. | ||
* Used in conjunction with expireTime. | ||
*/ | ||
expired: boolean; | ||
/** | ||
* Time when token should be considered expired. | ||
* Used in conjunction with expired. | ||
*/ | ||
expireTime: Date; | ||
static expiryWindow: number; | ||
} | ||
export interface TokenOptions { | ||
/** | ||
* The literal token string. | ||
*/ | ||
token: string | ||
/** | ||
* The time at which the token expires. | ||
*/ | ||
expireTime?: Date | ||
/** | ||
* The literal token string. | ||
*/ | ||
token: string; | ||
/** | ||
* The time at which the token expires. | ||
*/ | ||
expireTime?: Date; | ||
} |
@@ -1,2 +0,2 @@ | ||
import {Token} from '../token'; | ||
import { Token } from '../token'; | ||
@@ -11,3 +11,3 @@ export class SSOTokenProvider extends Token { | ||
export interface SSOTokenProviderOptions { | ||
profile?: string | ||
profile?: string; | ||
} |
@@ -1,2 +0,2 @@ | ||
import {Token, TokenOptions} from '../token'; | ||
import { Token, TokenOptions } from '../token'; | ||
@@ -8,2 +8,2 @@ export class StaticTokenProvider extends Token { | ||
constructor(options?: TokenOptions); | ||
} | ||
} |
@@ -1,3 +0,3 @@ | ||
import {Token} from '../token'; | ||
import {AWSError} from '../error'; | ||
import { AWSError } from '../error'; | ||
import { Token } from '../token'; | ||
export class TokenProviderChain { | ||
@@ -7,7 +7,7 @@ /** | ||
*/ | ||
constructor(providers?: provider[]) | ||
constructor(providers?: provider[]); | ||
/** | ||
* Resolves the provider chain by searching for the first set of token in providers. | ||
*/ | ||
resolve(callback:(err: AWSError|null, token?: Token) => void): TokenProviderChain; | ||
resolve(callback: (err: AWSError | null, token?: Token) => void): TokenProviderChain; | ||
/** | ||
@@ -20,7 +20,7 @@ * Return a Promise on resolve() function | ||
*/ | ||
providers: Array<Token|provider>; | ||
providers: Array<Token | provider>; | ||
static defaultProviders: provider[] | ||
static defaultProviders: provider[]; | ||
} | ||
type provider = () => Token; |
{ | ||
"name": "@types/aws-sdk2-types", | ||
"version": "0.0.0", | ||
"version": "0.0.1", | ||
"description": "TypeScript definitions for aws-sdk2-types", | ||
@@ -30,4 +30,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-sdk2-types", | ||
}, | ||
"typesPublisherContentHash": "6cb8b3323742d5e8d7201bd04427228d3ad19e07c64752a68189d052d714cab7", | ||
"typeScriptVersion": "4.2" | ||
"typesPublisherContentHash": "b99d1af0aac4e6fa2791773c51eeff3f3c601295b1dd3d5849d49f9d60be61f5", | ||
"typeScriptVersion": "4.3" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
### Additional Details | ||
* Last updated: Mon, 30 Jan 2023 16:02:39 GMT | ||
* Last updated: Sat, 12 Aug 2023 14:32:38 GMT | ||
* Dependencies: [@types/node](https://npmjs.com/package/@types/node) | ||
@@ -14,0 +14,0 @@ * Global values: `AWS` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
2284643
34663