AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

AssumeRoleWithSAMLOutput

import "github.com/aws/aws-sdk-go/service/sts"

type AssumeRoleWithSAMLOutput struct { AssumedRoleUser *AssumedRoleUser `type:"structure"` Audience *string `type:"string"` Credentials *Credentials `type:"structure"` Issuer *string `type:"string"` NameQualifier *string `type:"string"` PackedPolicySize *int64 `type:"integer"` Subject *string `type:"string"` SubjectType *string `type:"string"` }

Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.

AssumedRoleUser

The identifiers for the temporary security credentials that the operation returns.

Audience

Type: *string

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

Credentials

AWS credentials for API authentication.

Issuer

Type: *string

The value of the Issuer element of the SAML assertion.

NameQualifier

Type: *string

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

PackedPolicySize

Type: *int64

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Subject

Type: *string

The value of the NameID element in the Subject element of the SAML assertion.

SubjectType

Type: *string

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

Method

GoString

func (s AssumeRoleWithSAMLOutput) GoString() string

GoString returns the string representation

SetAssumedRoleUser

func (s *AssumeRoleWithSAMLOutput) SetAssumedRoleUser(v *AssumedRoleUser) *AssumeRoleWithSAMLOutput

SetAssumedRoleUser sets the AssumedRoleUser field's value.

SetAudience

func (s *AssumeRoleWithSAMLOutput) SetAudience(v string) *AssumeRoleWithSAMLOutput

SetAudience sets the Audience field's value.

SetCredentials

func (s *AssumeRoleWithSAMLOutput) SetCredentials(v *Credentials) *AssumeRoleWithSAMLOutput

SetCredentials sets the Credentials field's value.

SetIssuer

func (s *AssumeRoleWithSAMLOutput) SetIssuer(v string) *AssumeRoleWithSAMLOutput

SetIssuer sets the Issuer field's value.

SetNameQualifier

func (s *AssumeRoleWithSAMLOutput) SetNameQualifier(v string) *AssumeRoleWithSAMLOutput

SetNameQualifier sets the NameQualifier field's value.

SetPackedPolicySize

func (s *AssumeRoleWithSAMLOutput) SetPackedPolicySize(v int64) *AssumeRoleWithSAMLOutput

SetPackedPolicySize sets the PackedPolicySize field's value.

SetSubject

func (s *AssumeRoleWithSAMLOutput) SetSubject(v string) *AssumeRoleWithSAMLOutput

SetSubject sets the Subject field's value.

SetSubjectType

func (s *AssumeRoleWithSAMLOutput) SetSubjectType(v string) *AssumeRoleWithSAMLOutput

SetSubjectType sets the SubjectType field's value.

String

func (s AssumeRoleWithSAMLOutput) String() string

String returns the string representation

On this page: