ISTSClient

Interface in AWS.STS

Interface for Simple Token Service (STS) client.

Methods

AssumeRole

function AssumeRole(const ARequest: ISTSAssumeRoleRequest): ISTSAssumeRoleResponse; overload;

ISTSAssumeRoleRequest → ISTSAssumeRoleResponse

Request a set of temporary security credentials that your credentials don't provide direct access to.

Parameters

Name	Description
ARequest	An AssumeRole request object.

Returns

Response containing AssumeRole results.

---

function AssumeRole(const ARoleArn: TARN; const ARoleSessionName: string): ISTSAssumeRoleResponse; overload;

ISTSAssumeRoleResponse

Request a set of temporary security credentials that your credentials don't provide direct access to.

Parameters

Name	Description
ARoleArn	An Amazon Resource Name (ARN) for an IAM role to assume.
ARoleSessionName	An identifier for the assumed role session.

Returns

Response containing AssumeRole results.

AssumeRoleWithSAML

function AssumeRoleWithSAML(const ARequest: ISTSAssumeRoleWithSAMLRequest): ISTSAssumeRoleWithSAMLResponse; overload;

ISTSAssumeRoleWithSAMLRequest → ISTSAssumeRoleWithSAMLResponse

Request a set of temporary security credentials for users who have been authenticated via a SAML authentication response.

Parameters

Name	Description
ARequest	An AssumeRoleWithSAML request object.

Returns

Response containing AssumeRoleWithSAML results.

---

function AssumeRoleWithSAML(const ARoleArn, APrincipalArn: TARN; const ASAMLAssertion: string): ISTSAssumeRoleWithSAMLResponse; overload;

ISTSAssumeRoleWithSAMLResponse

Request a set of temporary security credentials for users who have been authenticated via a SAML authentication response.

Parameters

Name	Description
ARoleArn	The Amazon Resource Name (ARN) of the role to assume.
APrincipalArn	The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
ASAMLAssertion	The Base64 encoded SAML authentication response provided by the IdP.

Returns

Response containing AssumeRoleWithSAML results.

AssumeRoleWithWebIdentity

function AssumeRoleWithWebIdentity(const ARequest: ISTSAssumeRoleWithWebIdentityRequest): ISTSAssumeRoleWithWebIdentityResponse; overload;

ISTSAssumeRoleWithWebIdentityRequest → ISTSAssumeRoleWithWebIdentityResponse

Request a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider.

Parameters

Name	Description
ARequest	An AssumeRoleWithWebIdentity request object.

Returns

Response containing AssumeRoleWithWebIdentity results.

---

function AssumeRoleWithWebIdentity(const ARoleArn: TARN; const ARoleSessionName, AWebIdentityToken: string): ISTSAssumeRoleWithWebIdentityResponse; overload;

ISTSAssumeRoleWithWebIdentityResponse

Request a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider.

Parameters

Name	Description
ARoleArn	An Amazon Resource Name (ARN) for an IAM role to assume.
ARoleSessionName	An identifier for the assumed role session.
AWebIdentityToken	The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.

Returns

Response containing AssumeRoleWithWebIdentity results.

DecodeAuthorizationMessage

function DecodeAuthorizationMessage(const ARequest: ISTSDecodeAuthorizationMessageRequest): ISTSDecodeAuthorizationMessageResponse; overload;

ISTSDecodeAuthorizationMessageRequest → ISTSDecodeAuthorizationMessageResponse

Decodes additional information about the authorization status of a request from an encoded message returned from an AWS request.

Parameters

Name	Description
ARequest	An DecodeAuthorizationMessage request object.

Returns

Response containing DecodeAuthorizationMessage results.

---

function DecodeAuthorizationMessage(const AEncodedMessage: string): ISTSDecodeAuthorizationMessageResponse; overload;

ISTSDecodeAuthorizationMessageResponse

Decodes additional information about the authorization status of a request from an encoded message returned from an AWS request.

Parameters

Name	Description
AEncodedMessage	An encoded message from and AWS response.

Returns

Response containing DecodeAuthorizationMessage results.

GetAccessKeyInfo

function GetAccessKeyInfo(const ARequest: ISTSGetAccessKeyInfoRequest): ISTSGetAccessKeyInfoResponse; overload;

ISTSGetAccessKeyInfoRequest → ISTSGetAccessKeyInfoResponse

Requests the account identifier for the specified Access Key ID.

Parameters

Name	Description
ARequest	An GetAccessKeyInfo request object.

Returns

Response containing GetAccessKeyInfo results.

---

function GetAccessKeyInfo(const AAccessKeyId: string): ISTSGetAccessKeyInfoResponse; overload;

ISTSGetAccessKeyInfoResponse

Requests the account identifier for the specified Access Key ID.

Parameters

Name	Description
AAccessKeyId	An Access Key identifier.

Returns

Response containing GetAccessKeyInfo results.

GetCallerIdentity

function GetCallerIdentity(const ARequest: ISTSGetCallerIdentityRequest): ISTSGetCallerIdentityResponse; overload;

ISTSGetCallerIdentityRequest → ISTSGetCallerIdentityResponse

Requests information about the IAM user or role calling the operation.

Parameters

Name	Description
ARequest	An GetCallerIdentity request object.

Returns

Response containing GetCallerIdentity results.

---

function GetCallerIdentity: ISTSGetCallerIdentityResponse; overload;

ISTSGetCallerIdentityResponse

Requests information about the IAM user or role calling the operation.

Returns

Response containing GetCallerIdentity results.

GetFederationToken

function GetFederationToken(const ARequest: ISTSGetFederationTokenRequest): ISTSGetFederationTokenResponse; overload;

ISTSGetFederationTokenRequest → ISTSGetFederationTokenResponse

Request a set of temporary security credentials for a federated user.

Parameters

Name	Description
ARequest	An GetFederationToken request object.

Returns

Response containing GetFederationToken results.

---

function GetFederationToken(const AName: string): ISTSGetFederationTokenResponse; overload;

ISTSGetFederationTokenResponse

Request a set of temporary security credentials for a federated user.

Parameters

Name	Description
AName	The name of the federated user.

Returns

Response containing GetFederationToken results.

GetSessionToken

function GetSessionToken(const ARequest: ISTSGetSessionTokenRequest): ISTSGetSessionTokenResponse; overload;

ISTSGetSessionTokenRequest → ISTSGetSessionTokenResponse

Request a set of temporary security credentials for an AWS account or IAM user.

Parameters

Name	Description
ARequest	An GetSessionToken request object.

Returns

Response containing GetSessionToken results.

---

function GetSessionToken: ISTSGetSessionTokenResponse; overload;

ISTSGetSessionTokenResponse

Request a set of temporary security credentials for an AWS account or IAM user.

Returns

Response containing GetSessionToken results.