AssumeRoleWithSAMLRequest Class
(QtAws::STS::AssumeRoleWithSAMLRequest)The AssumeRoleWithSAMLRequest class provides an interface for STS AssumeRoleWithSAML requests. More...
| Header: | #include <AssumeRoleWithSAMLRequest> |
| Inherits: | QtAws::STS::StsRequest |
Public Functions
| AssumeRoleWithSAMLRequest(const AssumeRoleWithSAMLRequest &other) | |
| AssumeRoleWithSAMLRequest() |
Reimplemented Public Functions
| virtual bool | isValid() const override |
- 7 public functions inherited from QtAws::STS::StsRequest
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Reimplemented Protected Functions
| virtual QtAws::Core::AwsAbstractResponse * | response(QNetworkReply * const reply) const override |
- 7 protected functions inherited from QtAws::STS::StsRequest
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The AssumeRoleWithSAMLRequest class provides an interface for STS AssumeRoleWithSAML requests.
<fullname>AWS Security Token Service</fullname>
The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>.
</p <note>
As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>.
</p </note>
For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html">AWS Services That Work with IAM</a> in the <i>IAM User Guide</i>.
</p
If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://aws.amazon.com/documentation/">http://aws.amazon.com/documentation/</a>.
</p
<b>Endpoints</b>
</p
The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available and are activated by default. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User
Guide</i>>
For information about STS endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region">Regions and Endpoints</a> in the <i>AWS General
Reference</i>>
<b>Recording API requests</b>
</p
STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">AWS CloudTrail User
See also StsClient::assumeRoleWithSAML.
Member Function Documentation
AssumeRoleWithSAMLRequest::AssumeRoleWithSAMLRequest(const AssumeRoleWithSAMLRequest &other)
Constructs a copy of other.
AssumeRoleWithSAMLRequest::AssumeRoleWithSAMLRequest()
Constructs a AssumeRoleWithSAMLRequest object.
[override virtual] bool AssumeRoleWithSAMLRequest::isValid() const
Reimplemented from AwsAbstractRequest::isValid().
[override virtual protected] QtAws::Core::AwsAbstractResponse *AssumeRoleWithSAMLRequest::response(QNetworkReply * const reply) const
Reimplemented from AwsAbstractRequest::response().
Returns a AssumeRoleWithSAMLResponse object to process reply.
See also QtAws::Core::AwsAbstractClient::send.
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.