Class: Aws::SSO::Types::GetRoleCredentialsRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sso/types.rb

Overview

Note:

When making an API call, you may pass GetRoleCredentialsRequest data as a hash:

{
  role_name: "RoleNameType", # required
  account_id: "AccountIdType", # required
  access_token: "AccessTokenType", # required
}

Constant Summary collapse

SENSITIVE =
[:access_token]

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

Instance Attribute Details

#access_tokenString

The token issued by the `CreateToken` API call. For more information, see [CreateToken] in the *AWS SSO OIDC API Reference Guide*.

[1]: docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html

Returns:

  • (String)

66
67
68
69
70
71
72
# File 'lib/aws-sdk-sso/types.rb', line 66

class GetRoleCredentialsRequest < Struct.new(
  :role_name,
  :account_id,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#account_idString

The identifier for the AWS account that is assigned to the user.

Returns:

  • (String)

66
67
68
69
70
71
72
# File 'lib/aws-sdk-sso/types.rb', line 66

class GetRoleCredentialsRequest < Struct.new(
  :role_name,
  :account_id,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#role_nameString

The friendly name of the role that is assigned to the user.

Returns:

  • (String)

66
67
68
69
70
71
72
# File 'lib/aws-sdk-sso/types.rb', line 66

class GetRoleCredentialsRequest < Struct.new(
  :role_name,
  :account_id,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end