Interface RequestSigningArguments

interface RequestSigningArguments {
    signableHeaders?: Set<string>;
    signingDate?: DateInput;
    signingRegion?: string;
    signingService?: string;
    unsignableHeaders?: Set<string>;
}

Hierarchy (view full)

Properties

signableHeaders? signingDate? signingRegion? signingService? unsignableHeaders?

Properties

Optional signableHeaders

signableHeaders?: Set<string>

A set of strings whose members represents headers that should be signed. Any values passed here will override those provided via unsignableHeaders, allowing them to be signed.

All headers in the provided request will have their names converted to lower case before signing.

Optional signingDate

signingDate?: DateInput

The date and time to be used as signature metadata. This value should be a Date object, a unix (epoch) timestamp, or a string that can be understood by the JavaScript Date constructor.If not supplied, the value returned by new Date() will be used.

Optional signingRegion

signingRegion?: string

The region name to sign the request. It will override the signing region of the signer in current invocation

Optional signingService

signingService?: string

The service signing name. It will override the service name of the signer in current invocation

Optional unsignableHeaders

unsignableHeaders?: Set<string>

A set of strings whose members represents headers that cannot be signed. All headers in the provided request will have their names converted to lower case and then checked for existence in the unsignableHeaders set.

Settings

Member Visibility

Theme

On This Page