STSService overview
Added in v1.0.0
Table of contents
constructors
makeSTSService
Signature
export declare const makeSTSService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
STSService (class)
Signature
export declare class STSService
Added in v1.0.0
STSService$ (interface)
Signature
export interface STSService$ {
/**
* @see {@link AssumeRoleCommand}
*/
assumeRole(
args: AssumeRoleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AssumeRoleCommandOutput,
| Cause.TimeoutError
| SdkError
| ExpiredTokenError
| MalformedPolicyDocumentError
| PackedPolicyTooLargeError
| RegionDisabledError
>
/**
* @see {@link AssumeRoleWithSAMLCommand}
*/
assumeRoleWithSAML(
args: AssumeRoleWithSAMLCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AssumeRoleWithSAMLCommandOutput,
| Cause.TimeoutError
| SdkError
| ExpiredTokenError
| IDPRejectedClaimError
| InvalidIdentityTokenError
| MalformedPolicyDocumentError
| PackedPolicyTooLargeError
| RegionDisabledError
>
/**
* @see {@link AssumeRoleWithWebIdentityCommand}
*/
assumeRoleWithWebIdentity(
args: AssumeRoleWithWebIdentityCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AssumeRoleWithWebIdentityCommandOutput,
| Cause.TimeoutError
| SdkError
| ExpiredTokenError
| IDPCommunicationError
| IDPRejectedClaimError
| InvalidIdentityTokenError
| MalformedPolicyDocumentError
| PackedPolicyTooLargeError
| RegionDisabledError
>
/**
* @see {@link AssumeRootCommand}
*/
assumeRoot(
args: AssumeRootCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<AssumeRootCommandOutput, Cause.TimeoutError | SdkError | ExpiredTokenError | RegionDisabledError>
/**
* @see {@link DecodeAuthorizationMessageCommand}
*/
decodeAuthorizationMessage(
args: DecodeAuthorizationMessageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DecodeAuthorizationMessageCommandOutput,
Cause.TimeoutError | SdkError | InvalidAuthorizationMessageError
>
/**
* @see {@link GetAccessKeyInfoCommand}
*/
getAccessKeyInfo(
args: GetAccessKeyInfoCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetAccessKeyInfoCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link GetCallerIdentityCommand}
*/
getCallerIdentity(
args: GetCallerIdentityCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetCallerIdentityCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link GetDelegatedAccessTokenCommand}
*/
getDelegatedAccessToken(
args: GetDelegatedAccessTokenCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetDelegatedAccessTokenCommandOutput,
Cause.TimeoutError | SdkError | ExpiredTradeInTokenError | PackedPolicyTooLargeError | RegionDisabledError
>
/**
* @see {@link GetFederationTokenCommand}
*/
getFederationToken(
args: GetFederationTokenCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetFederationTokenCommandOutput,
Cause.TimeoutError | SdkError | MalformedPolicyDocumentError | PackedPolicyTooLargeError | RegionDisabledError
>
/**
* @see {@link GetSessionTokenCommand}
*/
getSessionToken(
args: GetSessionTokenCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetSessionTokenCommandOutput, Cause.TimeoutError | SdkError | RegionDisabledError>
/**
* @see {@link GetWebIdentityTokenCommand}
*/
getWebIdentityToken(
args: GetWebIdentityTokenCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetWebIdentityTokenCommandOutput,
| Cause.TimeoutError
| SdkError
| JWTPayloadSizeExceededError
| OutboundWebIdentityFederationDisabledError
| SessionDurationEscalationError
>
}
Added in v1.0.0
utils
STSService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<STSClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = STSService$
Added in v1.0.0