Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(client-sts): move documentation before release tag #5906

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clients/client-sts/src/STS.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,11 @@ export interface STS {
}

/**
* @public
* <fullname>Security Token Service</fullname>
* <p>Security Token Service (STS) enables you to request temporary, limited-privilege
* credentials for users. This guide provides descriptions of the STS API. For
* more information about using this service, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>.</p>
* @public
*/
export class STS extends STSClient implements STS {}
createAggregatedClient(commands, STS);
2 changes: 1 addition & 1 deletion clients/client-sts/src/STSClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -276,11 +276,11 @@ export type STSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
export interface STSClientResolvedConfig extends STSClientResolvedConfigType {}

/**
* @public
* <fullname>Security Token Service</fullname>
* <p>Security Token Service (STS) enables you to request temporary, limited-privilege
* credentials for users. This guide provides descriptions of the STS API. For
* more information about using this service, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>.</p>
* @public
*/
export class STSClient extends __Client<
__HttpHandlerOptions,
Expand Down
2 changes: 1 addition & 1 deletion clients/client-sts/src/commands/AssumeRoleCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface AssumeRoleCommandInput extends AssumeRoleRequest {}
export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataBearer {}

/**
* @public
* <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
* resources. These temporary credentials consist of an access key ID, a secret access key,
* and a security token. Typically, you use <code>AssumeRole</code> within your account or for
Expand Down Expand Up @@ -206,6 +205,7 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To assume a role
* ```javascript
* //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface AssumeRoleWithSAMLCommandInput extends AssumeRoleWithSAMLReques
export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLResponse, __MetadataBearer {}

/**
* @public
* <p>Returns a set of temporary security credentials for users who have been authenticated
* via a SAML authentication response. This operation provides a mechanism for tying an
* enterprise identity store or directory to role-based Amazon Web Services access without user-specific
Expand Down Expand Up @@ -249,6 +248,7 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To assume a role using a SAML assertion
* ```javascript
* //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export interface AssumeRoleWithWebIdentityCommandInput extends AssumeRoleWithWeb
export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWebIdentityResponse, __MetadataBearer {}

/**
* @public
* <p>Returns a set of temporary security credentials for users who have been authenticated in
* a mobile or web application with a web identity provider. Example providers include the
* OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible
Expand Down Expand Up @@ -258,6 +257,7 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To assume a role as an OpenID Connect-federated user
* ```javascript
* //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface DecodeAuthorizationMessageCommandInput extends DecodeAuthorizat
export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthorizationMessageResponse, __MetadataBearer {}

/**
* @public
* <p>Decodes additional information about the authorization status of a request from an
* encoded message returned in response to an Amazon Web Services request.</p>
* <p>For example, if a user is not authorized to perform an operation that he or she has
Expand Down Expand Up @@ -95,6 +94,7 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To decode information about an authorization status of a request
* ```javascript
* //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetAccessKeyInfoCommandInput extends GetAccessKeyInfoRequest {}
export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse, __MetadataBearer {}

/**
* @public
* <p>Returns the account identifier for the specified access key ID.</p>
* <p>Access keys consist of two parts: an access key ID (for example,
* <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
Expand Down Expand Up @@ -71,6 +70,7 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
*/
export class GetAccessKeyInfoCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetCallerIdentityCommandInput extends GetCallerIdentityRequest
export interface GetCallerIdentityCommandOutput extends GetCallerIdentityResponse, __MetadataBearer {}

/**
* @public
* <p>Returns details about the IAM user or role whose credentials are used to
* call the operation.</p>
* <note>
Expand Down Expand Up @@ -64,6 +63,7 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To get details about a calling IAM user
* ```javascript
* // This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export interface GetFederationTokenCommandInput extends GetFederationTokenReques
export interface GetFederationTokenCommandOutput extends GetFederationTokenResponse, __MetadataBearer {}

/**
* @public
* <p>Returns a set of temporary security credentials (consisting of an access key ID, a
* secret access key, and a security token) for a user. A typical use is in a proxy
* application that gets temporary security credentials on behalf of distributed applications
Expand Down Expand Up @@ -192,6 +191,7 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To get temporary credentials for a role by using GetFederationToken
* ```javascript
* //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export interface GetSessionTokenCommandInput extends GetSessionTokenRequest {}
export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, __MetadataBearer {}

/**
* @public
* <p>Returns a set of temporary credentials for an Amazon Web Services account or IAM user.
* The credentials consist of an access key ID, a secret access key, and a security token.
* Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect
Expand Down Expand Up @@ -131,6 +130,7 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
* @throws {@link STSServiceException}
* <p>Base exception class for all service exceptions from STS service.</p>
*
* @public
* @example To get temporary credentials for an IAM user or an AWS account
* ```javascript
* //
Expand Down
Loading
Loading