Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface PinpointEmailClientConfig

The configuration interface of PinpointEmailClient class constructor that set the region, credentials and other options.

Hierarchy

Properties

credentials? customUserAgent? defaultsMode? disableHostPrefix? endpoint? endpointProvider? logger? maxAttempts? region? requestHandler? retryMode? retryStrategy? signer? signingEscapePath? signingRegion? systemClockOffset? tls? useDualstackEndpoint? useFipsEndpoint?

Properties

Optional credentials

credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

The credentials used to sign requests.

Optional customUserAgent

customUserAgent?: string | UserAgent

The custom user agent header that would be appended to default one

Optional defaultsMode

defaultsMode?: DefaultsMode | Provider<DefaultsMode>

The @aws-sdk/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

Optional disableHostPrefix

disableHostPrefix?: boolean

Disable dyanamically changing the endpoint of the client based on the hostPrefix trait of an operation.

Optional endpoint

endpoint?: Object

The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).

Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

Optional endpointProvider

endpointProvider?: ((params: EndpointParameters, context?: {
    logger?: Logger;
}) => EndpointV2)

Type declaration

    • (params: EndpointParameters, context?: {
          logger?: Logger;
      }): EndpointV2

    • Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

      Parameters

      • params: EndpointParameters
      • Optional context: {
            logger?: Logger;
        }
        • Optional logger?: Logger

      Returns EndpointV2

Optional logger

logger?: Logger

Optional logger for logging debug/info/warn/error.

Optional maxAttempts

maxAttempts?: Object

Value for how many times a request will be made at most in case of retry.

Optional region

region?: Object

The AWS region to which this client will send requests

Optional requestHandler

requestHandler?: RequestHandler<any, any, HttpHandlerOptions> & HttpHandler

The HTTP handler to use. Fetch in browser and Https in Nodejs.

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

Optional retryStrategy

retryStrategy?: RetryStrategy | RetryStrategyV2

The strategy to retry the request. Using built-in exponential backoff strategy by default.

Optional signer

signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

The signer to use when signing requests.

Optional signingEscapePath

signingEscapePath?: boolean

Whether to escape request path when signing the request.

Optional signingRegion

signingRegion?: string

The region where you want to sign your request against. This can be different to the region in the endpoint.

Optional systemClockOffset

systemClockOffset?: number

An offset value in milliseconds to apply to all signing times.

Optional tls

tls?: boolean

Whether TLS is enabled for requests.

Deprecated

Optional useDualstackEndpoint

useDualstackEndpoint?: Object

Enables IPv6/IPv4 dualstack endpoint.

Optional useFipsEndpoint

useFipsEndpoint?: Object

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme