{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.sts#AWSSecurityTokenServiceV20110615": { "type": "service", "version": "2011-06-15", "operations": [ { "target": "com.amazonaws.sts#AssumeRole" }, { "target": "com.amazonaws.sts#AssumeRoleWithSAML" }, { "target": "com.amazonaws.sts#AssumeRoleWithWebIdentity" }, { "target": "com.amazonaws.sts#AssumeRoot" }, { "target": "com.amazonaws.sts#DecodeAuthorizationMessage" }, { "target": "com.amazonaws.sts#GetAccessKeyInfo" }, { "target": "com.amazonaws.sts#GetCallerIdentity" }, { "target": "com.amazonaws.sts#GetDelegatedAccessToken" }, { "target": "com.amazonaws.sts#GetFederationToken" }, { "target": "com.amazonaws.sts#GetScopedCredentials" }, { "target": "com.amazonaws.sts#GetSessionToken" }, { "target": "com.amazonaws.sts#GetWebIdentityToken" } ], "traits": { "aws.api#service": { "sdkId": "STS", "arnNamespace": "sts", "cloudFormationName": "STS", "cloudTrailEventSource": "sts.amazonaws.com", "endpointPrefix": "sts" }, "aws.auth#sigv4": { "name": "sts" }, "aws.auth#sigv4a": { "name": "sts" }, "aws.protocols#awsQuery": {}, "smithy.api#auth": [ "aws.auth#sigv4", "aws.auth#sigv4a" ], "smithy.api#documentation": "Security Token Service\n

Amazon Web Services provides Security Token Service (STS) as a web service that enables you to request temporary,\n limited-privilege credentials for users. This guide describes the STS API. For more\n information, see Temporary Security Credentials\n in the IAM User Guide.

\n \n

As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of\n libraries and sample code for various programming languages and platforms such as Java,\n Ruby, .NET, iOS, Android, and others. The SDKs provide a convenient way to create\n programmatic access to STS. For example, the SDKs can cryptographically sign requests,\n manage errors, and retry requests automatically. For information about the Amazon Web Services SDKs, see\n Tools to Build on Amazon Web Services.

\n
\n

For information about setting up signatures and authorization through the API, see Signing Amazon Web Services\n API Requests in the Amazon Web Services General Reference. For general information\n about the Query API, see Making Query Requests in the\n IAM User Guide. For information about using security tokens with\n other Amazon Web Services products, see Amazon Web Services Services\n That Work with IAM in the IAM User Guide.

\n

For information about STS endpoints, see STS Regions and\n endpoints in the IAM User Guide. For information about\n logging STS API calls, see Logging IAM and STS API calls\n with CloudTrail in the IAM User Guide.

", "smithy.api#title": "AWS Security Token Service", "smithy.api#xmlNamespace": { "uri": "https://sts.amazonaws.com/doc/2011-06-15/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "UseGlobalEndpoint": { "builtIn": "AWS::STS::UseGlobalEndpoint", "required": true, "default": false, "documentation": "Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.", "type": "boolean" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-global" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseGlobalEndpoint" }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-central-1" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-south-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-north-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-2" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-3" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "sa-east-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-2" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-2" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ca-central-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-southeast-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-northeast-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-southeast-2" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 31, "nodes": "/////wAAAAH/////AAAAAAAAAB4AAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAABkAAAAGAAAABAAAABgAAAAHAAAABQX14QEAAAAIAAAABgAAAAkF9eENAAAABwX14QEAAAAKAAAACgX14QEAAAALAAAACwX14QEAAAAMAAAADAX14QEAAAANAAAADQX14QEAAAAOAAAADgX14QEAAAAPAAAADwX14QEAAAAQAAAAEAX14QEAAAARAAAAEQX14QEAAAASAAAAEgX14QEAAAATAAAAEwX14QEAAAAUAAAAFAX14QEAAAAVAAAAFQX14QEAAAAWAAAAFgX14QEAAAAXAAAAFwX14QEF9eECAAAACAX14QsF9eEMAAAABAAAABwAAAAaAAAACQAAABsF9eEKAAAAGAX14QgF9eEJAAAACAAAAB0F9eEHAAAACQX14QYF9eEHAAAAAwX14QMAAAAfAAAABAX14QQF9eEF" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "UseGlobalEndpoint": { "builtIn": "AWS::STS::UseGlobalEndpoint", "required": true, "default": false, "documentation": "Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.", "type": "boolean" } }, "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseGlobalEndpoint" }, true ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-northeast-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-south-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-southeast-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ap-southeast-2" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-global" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ca-central-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-central-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-north-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-2" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "eu-west-3" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "sa-east-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-2" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-1" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-2" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://sts-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://sts.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-global" ] } ], "endpoint": { "url": "https://sts.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://sts.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region aws-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "params": { "Region": "aws-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://sts.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://sts-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } }, { "documentation": "UseGlobalEndpoint with legacy region `ap-northeast-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "ap-northeast-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `ap-south-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "ap-south-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `ap-southeast-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "ap-southeast-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `ap-southeast-2`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "ap-southeast-2", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `aws-global`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "aws-global", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "aws-global", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `ca-central-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "ca-central-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `eu-central-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "eu-central-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `eu-north-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "eu-north-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `eu-west-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "eu-west-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `eu-west-2`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "eu-west-2", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `eu-west-3`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "eu-west-3", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `sa-east-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "sa-east-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `us-east-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `us-east-2`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `us-west-1`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-1", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region `us-west-2`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-1" } ] }, "url": "https://sts.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with Non-legacy region `us-east-3`", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "sts", "signingRegion": "us-east-3" } ] }, "url": "https://sts.us-east-3.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-3", "AWS::STS::UseGlobalEndpoint": true }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-east-3", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true } }, { "documentation": "UseGlobalEndpoint with legacy region and custom endpoint", "expect": { "endpoint": { "url": "https://example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-1", "AWS::STS::UseGlobalEndpoint": true, "SDK::Endpoint": "https://example.com" }, "operationName": "GetCallerIdentity" } ], "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": true, "Endpoint": "https://example.com" } }, { "documentation": "UseGlobalEndpoint with unset region and custom endpoint", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "UseGlobalEndpoint": false, "Endpoint": "https://example.com" } } ], "version": "1.0" } } }, "com.amazonaws.sts#AssumeRole": { "type": "operation", "input": { "target": "com.amazonaws.sts#AssumeRoleRequest" }, "output": { "target": "com.amazonaws.sts#AssumeRoleResponse" }, "errors": [ { "target": "com.amazonaws.sts#ExpiredTokenException" }, { "target": "com.amazonaws.sts#InvalidContextAssertionException" }, { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#documentation": "

Returns a set of temporary security credentials that you can use to access Amazon Web Services\n resources. These temporary credentials consist of an access key ID, a secret access key,\n and a security token. Typically, you use AssumeRole within your account or for\n cross-account access. For a comparison of AssumeRole with other API operations\n that produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRole can be used to\n make API calls to any Amazon Web Services service with the following exception: You cannot call the\n Amazon Web Services STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to this operation. You can\n pass a single JSON policy document to use as an inline session policy. You can also specify\n up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies.\n The plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

When you create a role, you create two policies: a role trust policy that specifies\n who can assume the role, and a permissions policy that specifies\n what can be done with the role. You specify the trusted principal\n that is allowed to assume the role in the role trust policy.

\n

To assume a role from a different account, your Amazon Web Services account must be trusted by the\n role. The trust relationship is defined in the role's trust policy when the role is\n created. That trust policy states which accounts are allowed to delegate that access to\n users in the account.

\n

A user who wants to access a role in a different account must also have permissions that\n are delegated from the account administrator. The administrator must attach a policy that\n allows the user to call AssumeRole for the ARN of the role in the other\n account.

\n

To allow a user to assume a role in the same account, you can do either of the\n following:

\n \n

You can do either because the role\u2019s trust policy acts as an IAM resource-based\n policy. When a resource-based policy grants access to a principal in the same account, no\n additional identity-based policy is required. For more information about trust policies and\n resource-based policies, see IAM Policies in the\n IAM User Guide.

\n

\n Tags\n

\n

(Optional) You can pass tag key-value pairs to your session. These tags are called\n session tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Using MFA with AssumeRole\n

\n

(Optional) You can include multi-factor authentication (MFA) information when you call\n AssumeRole. This is useful for cross-account scenarios to ensure that the\n user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that\n scenario, the trust policy of the role being assumed includes a condition that tests for\n MFA authentication. If the caller does not include valid MFA information, the request to\n assume the role is denied. The condition in a trust policy that tests for MFA\n authentication might look like the following example.

\n

\n \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}\n

\n

For more information, see Configuring MFA-Protected API Access\n in the IAM User Guide guide.

\n

To use MFA with AssumeRole, you pass values for the\n SerialNumber and TokenCode parameters. The\n SerialNumber value identifies the user's hardware or virtual MFA device.\n The TokenCode is the time-based one-time password (TOTP) that the MFA device\n produces.

", "smithy.api#examples": [ { "title": "To assume a role", "documentation": "", "input": { "RoleArn": "arn:aws:iam::123456789012:role/demo", "RoleSessionName": "testAssumeRoleSession", "Policy": "escaped-JSON-IAM-POLICY", "Tags": [ { "Key": "Project", "Value": "Unicorn" }, { "Key": "Team", "Value": "Automation" }, { "Key": "Cost-Center", "Value": "12345" } ], "TransitiveTagKeys": [ "Project", "Cost-Center" ], "ExternalId": "123ABC" }, "output": { "Credentials": { "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "Expiration": "2011-07-15T23:28:33.359Z" }, "AssumedRoleUser": { "Arn": "arn:aws:sts::123456789012:assumed-role/demo/Bob", "AssumedRoleId": "ARO123EXAMPLE123:Bob" }, "PackedPolicySize": 8 } } ] } }, "com.amazonaws.sts#AssumeRoleRequest": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to assume.

", "smithy.api#required": {} } }, "RoleSessionName": { "target": "com.amazonaws.sts#roleSessionNameType", "traits": { "smithy.api#documentation": "

An identifier for the assumed role session.

\n

Use the role session name to uniquely identify a session when the same role is assumed\n by different principals or for different reasons. In cross-account scenarios, the role\n session name is visible to, and can be logged by the account that owns the role. The role\n session name is also used in the ARN of the assumed role principal. This means that\n subsequent cross-account API requests that use the temporary security credentials will\n expose the role session name to the external account in their CloudTrail logs.

\n

For security purposes, administrators can view this field in CloudTrail logs to help identify who performed an action in Amazon Web Services. Your\n administrator might require that you specify your user name as the session name when you\n assume the role. For more information, see \n sts:RoleSessionName\n .

\n

The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=,.@-

", "smithy.api#required": {} } }, "PolicyArns": { "target": "com.amazonaws.sts#policyDescriptorListType", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

\n

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

\n

Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

" } }, "Policy": { "target": "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType", "traits": { "smithy.api#documentation": "

An IAM policy in JSON format that you want to use as an inline session policy.

\n

This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

\n

For more information about role session permissions, see Session\n policies.

" } }, "DurationSeconds": { "target": "com.amazonaws.sts#roleDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, of the role session. The value specified can range from 900\n seconds (15 minutes) up to the maximum session duration set for the role. The maximum\n session duration setting can have a value from 1 hour to 12 hours. If you specify a value\n higher than this setting or the administrator setting (whichever is lower), the operation\n fails. For example, if you specify a session duration of 12 hours, but your administrator\n set the maximum session duration to 6 hours, your operation fails.

\n

Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour.\n When you use the AssumeRole API operation to assume a role, you can specify\n the duration of your role session with the DurationSeconds parameter. You can\n specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum\n session duration setting for your role. However, if you assume a role using role chaining\n and provide a DurationSeconds parameter value greater than one hour, the\n operation fails. To learn how to view the maximum value for your role, see Update the maximum session duration for a role.

\n

By default, the value is set to 3600 seconds.

\n \n

The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.

\n
" } }, "Tags": { "target": "com.amazonaws.sts#tagListType", "traits": { "smithy.api#documentation": "

A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging Amazon Web Services STS\n Sessions in the IAM User Guide.

\n

This parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can\u2019t exceed 128 characters, and the values can\u2019t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

\n

You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.

\n

Tag key\u2013value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

\n

Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.

" } }, "TransitiveTagKeys": { "target": "com.amazonaws.sts#tagKeyListType", "traits": { "smithy.api#documentation": "

A list of keys for session tags that you want to set as transitive. If you set a tag key\n as transitive, the corresponding key and value passes to subsequent sessions in a role\n chain. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

This parameter is optional. The transitive status of a session tag does not impact its\n packed binary size.

\n

If you choose not to specify a transitive tag key, then no tags are passed from this\n session to any subsequent sessions.

" } }, "ExternalId": { "target": "com.amazonaws.sts#externalIdType", "traits": { "smithy.api#documentation": "

A unique identifier that might be required when you assume a role in another account. If\n the administrator of the account to which the role belongs provided you with an external\n ID, then provide that value in the ExternalId parameter. This value can be any\n string, such as a passphrase or account number. A cross-account role is usually set up to\n trust everyone in an account. Therefore, the administrator of the trusting account might\n send an external ID to the administrator of the trusted account. That way, only someone\n with the ID can assume the role, rather than everyone in the account. For more information\n about the external ID, see How to Use an External ID\n When Granting Access to Your Amazon Web Services Resources to a Third Party in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=,.@:\\/-

" } }, "SerialNumber": { "target": "com.amazonaws.sts#serialNumberType", "traits": { "smithy.api#documentation": "

The identification number of the MFA device that is associated with the user who is\n making the AssumeRole call. Specify this value if the trust policy of the role\n being assumed includes a condition that requires MFA authentication. The value is either\n the serial number for a hardware device (such as GAHT12345678) or an Amazon\n Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user).

\n

The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: +=/:,.@-

" } }, "TokenCode": { "target": "com.amazonaws.sts#tokenCodeType", "traits": { "smithy.api#documentation": "

The value provided by the MFA device, if the trust policy of the role being assumed\n requires MFA. (In other words, if the policy includes a condition that tests for MFA). If\n the role being assumed requires MFA and if the TokenCode value is missing or\n expired, the AssumeRole call returns an \"access denied\" error.

\n

The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.

" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The source identity specified by the principal that is calling the\n AssumeRole operation. The source identity value persists across chained role sessions.

\n

You can require users to specify a source identity when they assume a role. You do this\n by using the \n sts:SourceIdentity\n condition key in a role trust policy. You\n can use source identity information in CloudTrail logs to determine who took actions with a\n role. You can use the aws:SourceIdentity condition key to further control\n access to Amazon Web Services resources based on the value of source identity. For more information about\n using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: +=,.@-. You cannot use a value that begins with the text\n aws:. This prefix is reserved for Amazon Web Services internal use.

" } }, "ProvidedContexts": { "target": "com.amazonaws.sts#ProvidedContextsListType", "traits": { "smithy.api#documentation": "

A list of previously acquired trusted context assertions in the format of a JSON array.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

\n

The following is an example of a ProvidedContext value that includes a\n single trusted context assertion and the ARN of the context provider from which the trusted\n context assertion was generated.

\n

\n [{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/IdentityCenter\",\"ContextAssertion\":\"trusted-context-assertion\"}]\n

" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#AssumeRoleResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "AssumedRoleUser": { "target": "com.amazonaws.sts#AssumedRoleUser", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

" } }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#deprecated": { "since": "2026-06-17", "message": "Deprecated. Replaced by SessionTokenUtilization." }, "smithy.api#documentation": "

The percentage (0-100) of the maximum allowed session token size that the returned\n session token consumes.

\n

This field is deprecated. Use SessionTokenUtilization instead.

" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The source identity specified by the principal that is calling the\n AssumeRole operation.

\n

You can require users to specify a source identity when they assume a role. You do this\n by using the sts:SourceIdentity condition key in a role trust policy. You can\n use source identity information in CloudTrail logs to determine who took actions with a role.\n You can use the aws:SourceIdentity condition key to further control access to\n Amazon Web Services resources based on the value of source identity. For more information about using\n source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful AssumeRole request, including\n temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

", "smithy.api#output": {} } }, "com.amazonaws.sts#AssumeRoleWithSAML": { "type": "operation", "input": { "target": "com.amazonaws.sts#AssumeRoleWithSAMLRequest" }, "output": { "target": "com.amazonaws.sts#AssumeRoleWithSAMLResponse" }, "errors": [ { "target": "com.amazonaws.sts#ExpiredTokenException" }, { "target": "com.amazonaws.sts#IDPRejectedClaimException" }, { "target": "com.amazonaws.sts#InvalidIdentityTokenException" }, { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "

Returns a set of temporary security credentials for users who have been authenticated\n via a SAML authentication response. This operation provides a mechanism for tying an\n enterprise identity store or directory to role-based Amazon Web Services access without user-specific\n credentials or configuration. For a comparison of AssumeRoleWithSAML with the\n other API operations that produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.

\n

The temporary security credentials returned by this operation consist of an access key\n ID, a secret access key, and a security token. Applications can use these temporary\n security credentials to sign calls to Amazon Web Services services.

\n \n

AssumeRoleWithSAML will not work on IAM Identity Center managed roles. These roles' names start\n with AWSReservedSSO_.

\n
\n

\n Session Duration\n

\n

By default, the temporary security credentials created by\n AssumeRoleWithSAML last for one hour. However, you can use the optional\n DurationSeconds parameter to specify the duration of your session. Your\n role session lasts for the duration that you specify, or until the time specified in the\n SAML authentication response's SessionNotOnOrAfter value, whichever is\n shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes)\n up to the maximum session duration setting for the role. This setting can have a value from\n 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

\n \n

\n Role chaining limits your CLI or Amazon Web Services API role\n session to a maximum of one hour. When you use the AssumeRole API operation\n to assume a role, you can specify the duration of your role session with the\n DurationSeconds parameter. You can specify a parameter value of up to\n 43200 seconds (12 hours), depending on the maximum session duration setting for your\n role. However, if you assume a role using role chaining and provide a\n DurationSeconds parameter value greater than one hour, the operation\n fails.

\n
\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRoleWithSAML can be\n used to make API calls to any Amazon Web Services service with the following exception: you cannot call\n the STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security\n credentials. The identity of the caller is validated by using keys in the metadata document\n that is uploaded for the SAML provider entity for your identity provider.

\n \n

Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs.\n The entry includes the value in the NameID element of the SAML assertion.\n We recommend that you use a NameIDType that is not associated with any\n personally identifiable information (PII). For example, you could instead use the\n persistent identifier\n (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

\n
\n

\n Tags\n

\n

(Optional) You can configure your IdP to pass attributes into your SAML assertion as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

You can pass up to 50 session tags. The plaintext session tag keys can\u2019t exceed 128\n characters and the values can\u2019t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

\n

You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, session tags override the role's tags with the same key.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n SAML Configuration\n

\n

Before your application can call AssumeRoleWithSAML, you must configure\n your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you\n must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that\n represents your identity provider. You must also create an IAM role that specifies this\n SAML provider in its trust policy.

\n

For more information, see the following resources:

\n ", "smithy.api#examples": [ { "title": "To assume a role using a SAML assertion", "documentation": "", "input": { "RoleArn": "arn:aws:iam::123456789012:role/TestSaml", "PrincipalArn": "arn:aws:iam::123456789012:saml-provider/SAML-test", "SAMLAssertion": "VERYLONGENCODEDASSERTIONEXAMPLExzYW1sOkF1ZGllbmNlPmJsYW5rPC9zYW1sOkF1ZGllbmNlPjwvc2FtbDpBdWRpZW5jZVJlc3RyaWN0aW9uPjwvc2FtbDpDb25kaXRpb25zPjxzYW1sOlN1YmplY3Q+PHNhbWw6TmFtZUlEIEZvcm1hdD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm5hbWVpZC1mb3JtYXQ6dHJhbnNpZW50Ij5TYW1sRXhhbXBsZTwvc2FtbDpOYW1lSUQ+PHNhbWw6U3ViamVjdENvbmZpcm1hdGlvbiBNZXRob2Q9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpjbTpiZWFyZXIiPjxzYW1sOlN1YmplY3RDb25maXJtYXRpb25EYXRhIE5vdE9uT3JBZnRlcj0iMjAxOS0xMS0wMVQyMDoyNTowNS4xNDVaIiBSZWNpcGllbnQ9Imh0dHBzOi8vc2lnbmluLmF3cy5hbWF6b24uY29tL3NhbWwiLz48L3NhbWw6U3ViamVjdENvbmZpcm1hdGlvbj48L3NhbWw6U3ViamVjdD48c2FtbDpBdXRoblN0YXRlbWVudCBBdXRoPD94bWwgdmpSZXNwb25zZT4=", "DurationSeconds": 3600 }, "output": { "Issuer": "https://integ.example.com/idp/shibboleth", "AssumedRoleUser": { "AssumedRoleId": "ARO456EXAMPLE789:TestSaml", "Arn": "arn:aws:sts::123456789012:assumed-role/TestSaml" }, "Credentials": { "SecretAccessKey": "8P+SQvWIuLnKhh8d++jpw0nNmQRBZvNEXAMPLEKEY", "AccessKeyId": "ASIAV3ZUEFP6EXAMPLE", "SessionToken": "IQoJb3JpZ2luX2VjEOz////////////////////wEXAMPLEtMSJHMEUCIDoKK3JH9uGQE1z0sINr5M4jk+Na8KHDcCYRVjJCZEvOAiEA3OvJGtw1EcViOleS2vhs8VdCKFJQWPQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==", "Expiration": "2019-11-01T20:26:47Z" }, "Audience": "https://signin.aws.amazon.com/saml", "SubjectType": "transient", "PackedPolicySize": 6, "NameQualifier": "SbdGOnUkh1i4+EXAMPLExL/jEvs=", "Subject": "SamlExample" } } ], "smithy.api#optionalAuth": {} } }, "com.amazonaws.sts#AssumeRoleWithSAMLRequest": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that the caller is assuming.

", "smithy.api#required": {} } }, "PrincipalArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the\n IdP.

", "smithy.api#required": {} } }, "SAMLAssertion": { "target": "com.amazonaws.sts#SAMLAssertionType", "traits": { "smithy.api#documentation": "

The base64 encoded SAML authentication response provided by the IdP.

\n

For more information, see Configuring a Relying Party and\n Adding Claims in the IAM User Guide.

", "smithy.api#required": {} } }, "PolicyArns": { "target": "com.amazonaws.sts#policyDescriptorListType", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

\n

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

\n

Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

" } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { "smithy.api#documentation": "

An IAM policy in JSON format that you want to use as an inline session policy.

\n

This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

\n

For more information about role session permissions, see Session\n policies.

" } }, "DurationSeconds": { "target": "com.amazonaws.sts#roleDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, of the role session. Your role session lasts for the duration\n that you specify for the DurationSeconds parameter, or until the time\n specified in the SAML authentication response's SessionNotOnOrAfter value,\n whichever is shorter. You can provide a DurationSeconds value from 900 seconds\n (15 minutes) up to the maximum session duration setting for the role. This setting can have\n a value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.

\n

By default, the value is set to 3600 seconds.

\n \n

The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.

\n
" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#AssumeRoleWithSAMLResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "AssumedRoleUser": { "target": "com.amazonaws.sts#AssumedRoleUser", "traits": { "smithy.api#documentation": "

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

" } }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#deprecated": { "since": "2026-06-17", "message": "Deprecated. Replaced by SessionTokenUtilization." }, "smithy.api#documentation": "

The percentage (0-100) of the maximum allowed session token size that the returned\n session token consumes.

\n

This field is deprecated. Use SessionTokenUtilization instead.

" } }, "Subject": { "target": "com.amazonaws.sts#Subject", "traits": { "smithy.api#documentation": "

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

\n

This is not the trusted identity propagation subject (aws:OriginIdentity/Subject).\n When the session carries trusted identity propagation context, that value is returned in\n TrustedIdentityPropagationContext.

" } }, "SubjectType": { "target": "com.amazonaws.sts#SubjectType", "traits": { "smithy.api#documentation": "

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

\n

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

\n

This is not the trusted identity propagation subject type\n (aws:OriginIdentity/SubjectType). When the session carries trusted identity\n propagation context, that value is returned in\n TrustedIdentityPropagationContext.

" } }, "Issuer": { "target": "com.amazonaws.sts#Issuer", "traits": { "smithy.api#documentation": "

The value of the Issuer element of the SAML assertion.

\n

This is not the trusted identity propagation issuer (aws:OriginIdentity/Issuer).\n When the session carries trusted identity propagation context, that value is returned in\n TrustedIdentityPropagationContext.

" } }, "Audience": { "target": "com.amazonaws.sts#Audience", "traits": { "smithy.api#documentation": "

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

" } }, "NameQualifier": { "target": "com.amazonaws.sts#NameQualifier", "traits": { "smithy.api#documentation": "

A hash value based on the concatenation of the following:

\n \n

The combination of NameQualifier and Subject can be used to\n uniquely identify a user.

\n

The following pseudocode shows how the hash value is calculated:

\n

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

" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The value in the SourceIdentity attribute in the SAML assertion. The source\n identity value persists across chained role\n sessions.

\n

You can require users to set a source identity value when they assume a role. You do\n this by using the sts:SourceIdentity condition key in a role trust policy.\n That way, actions that are taken with the role are associated with that user. After the\n source identity is set, the value cannot be changed. It is present in the request for all\n actions that are taken by the role and persists across chained role\n sessions. You can configure your SAML identity provider to use an attribute associated with\n your users, like user name or email, as the source identity when calling\n AssumeRoleWithSAML. You do this by adding an attribute to the SAML\n assertion. For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" }, "TrustedIdentityPropagationContext": { "target": "com.amazonaws.sts#TrustedIdentityPropagationContext", "traits": { "smithy.api#documentation": "

The trusted identity propagation context that Amazon Web Services STS set in the\n session from the SAML assertion, through the context provider attached to the SAML\n identity provider. It is present only when Amazon Web Services STS set such context in\n the session. It contains the aws:OriginIdentity/Subject,\n aws:OriginIdentity/SubjectType, aws:OriginIdentity/Issuer and\n aws:OriginIdentity/FederatedProviderArn keys and the\n aws:TransactionContext/IdentityProvider/* keys that Amazon Web Services STS\n set in the session. Other keys in the session, such as\n aws:IdentityCenterInstanceArn and aws:IdentityStoreArn for an\n identity provider with an Identity Center instance attached, are not returned.

\n

Its OriginIdentity members share the names Subject,\n SubjectType and Issuer with members of this response but\n carry the trusted identity propagation values, which differ from the SAML assertion\n values.

\n

It is not returned when the SAML assertion is encrypted, even though the session carries\n the context.

\n

This element contains information about the end user. Do not log it.

" } } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful AssumeRoleWithSAML request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

", "smithy.api#output": {} } }, "com.amazonaws.sts#AssumeRoleWithWebIdentity": { "type": "operation", "input": { "target": "com.amazonaws.sts#AssumeRoleWithWebIdentityRequest" }, "output": { "target": "com.amazonaws.sts#AssumeRoleWithWebIdentityResponse" }, "errors": [ { "target": "com.amazonaws.sts#ExpiredTokenException" }, { "target": "com.amazonaws.sts#IDPCommunicationErrorException" }, { "target": "com.amazonaws.sts#IDPRejectedClaimException" }, { "target": "com.amazonaws.sts#InvalidIdentityTokenException" }, { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "

Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include the\n OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible\n identity provider such as Google or Amazon Cognito federated identities.

\n \n

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.

\n

To learn more about Amazon Cognito, see Amazon Cognito identity\n pools in Amazon Cognito Developer Guide.

\n
\n

Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term Amazon Web Services\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.

\n

The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to Amazon Web Services service API operations.

\n

\n Session Duration\n

\n

By default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see Update the maximum session duration for a role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

\n

\n Permissions\n

\n

The temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any Amazon Web Services service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.

\n

(Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

\n Tags\n

\n

(Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing\n session tags using AssumeRoleWithWebIdentity in the\n IAM User Guide.

\n

You can pass up to 50 session tags. The plaintext session tag keys can\u2019t exceed 128\n characters and the values can\u2019t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

\n

You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.

\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

\n

\n Identities\n

\n

Before your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.

\n \n

Calling AssumeRoleWithWebIdentity can result in an entry in your\n CloudTrail logs. The entry includes the Subject of\n the provided web identity token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.

\n
\n

For more information about how to use OIDC federation and the\n AssumeRoleWithWebIdentity API, see the following resources:

\n ", "smithy.api#examples": [ { "title": "To assume a role as an OpenID Connect-federated user", "documentation": "", "input": { "RoleArn": "arn:aws:iam::123456789012:role/FederatedWebIdentityRole", "RoleSessionName": "app1", "Policy": "escaped-JSON-IAM-POLICY", "WebIdentityToken": "Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ", "ProviderId": "www.amazon.com", "DurationSeconds": 3600 }, "output": { "Credentials": { "SessionToken": "AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "Expiration": "2014-10-24T23:00:23Z", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" }, "SubjectFromWebIdentityToken": "amzn1.account.AF6RHO7KZU5XRVQJGXK6HEXAMPLE", "AssumedRoleUser": { "Arn": "arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1", "AssumedRoleId": "AROACLKWSDQRAOEXAMPLE:app1" }, "PackedPolicySize": 123, "Provider": "www.amazon.com", "Audience": "client.5498841531868486423.1548@apps.example.com" } } ], "smithy.api#optionalAuth": {} } }, "com.amazonaws.sts#AssumeRoleWithWebIdentityRequest": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that the caller is assuming.

\n \n

Additional considerations apply to Amazon Cognito identity pools that assume cross-account IAM roles. The trust policies of these roles must accept the\n cognito-identity.amazonaws.com service principal and must contain the\n cognito-identity.amazonaws.com:aud condition key to restrict role\n assumption to users from your intended identity pools. A policy that trusts Amazon Cognito\n identity pools without this condition creates a risk that a user from an unintended\n identity pool can assume the role. For more information, see Trust policies for\n IAM roles in Basic (Classic) authentication in the Amazon Cognito\n Developer Guide.

\n
", "smithy.api#required": {} } }, "RoleSessionName": { "target": "com.amazonaws.sts#roleSessionNameType", "traits": { "smithy.api#documentation": "

An identifier for the assumed role session. Typically, you pass the name or identifier\n that is associated with the user who is using your application. That way, the temporary\n security credentials that your application will use are associated with that user. This\n session name is included as part of the ARN and assumed role ID in the\n AssumedRoleUser response element.

\n

For security purposes, administrators can view this field in CloudTrail logs to help identify who performed an action in Amazon Web Services. Your\n administrator might require that you specify your user name as the session name when you\n assume the role. For more information, see \n sts:RoleSessionName\n .

\n

The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

", "smithy.api#required": {} } }, "WebIdentityToken": { "target": "com.amazonaws.sts#clientTokenType", "traits": { "smithy.api#documentation": "

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n AssumeRoleWithWebIdentity call. Timestamps in the token must be formatted\n as either an integer or a long integer. Tokens must be signed using either RSA keys (RS256,\n RS384, or RS512) or ECDSA keys (ES256, ES384, or ES512).

", "smithy.api#required": {} } }, "ProviderId": { "target": "com.amazonaws.sts#urlType", "traits": { "smithy.api#documentation": "

The fully qualified host component of the domain name of the OAuth 2.0 identity\n provider. Do not specify this value for an OpenID Connect identity provider.

\n

Currently www.amazon.com and graph.facebook.com are the only\n supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and\n port numbers.

\n

Do not specify this value for OpenID Connect ID tokens.

" } }, "PolicyArns": { "target": "com.amazonaws.sts#policyDescriptorListType", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

\n

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plaintext that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

\n

Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

" } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { "smithy.api#documentation": "

An IAM policy in JSON format that you want to use as an inline session policy.

\n

This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent Amazon Web Services API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

\n

The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

\n

For more information about role session permissions, see Session\n policies.

" } }, "DurationSeconds": { "target": "com.amazonaws.sts#roleDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.

\n

By default, the value is set to 3600 seconds.

\n \n

The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the Amazon Web Services Management Console in the\n IAM User Guide.

\n
" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#AssumeRoleWithWebIdentityResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "SubjectFromWebIdentityToken": { "target": "com.amazonaws.sts#webIdentitySubjectType", "traits": { "smithy.api#documentation": "

The unique user identifier that is returned by the identity provider. This identifier is\n associated with the WebIdentityToken that was submitted with the\n AssumeRoleWithWebIdentity call. The identifier is typically unique to the\n user and the application that acquired the WebIdentityToken (pairwise\n identifier). For OpenID Connect ID tokens, this field contains the value returned by the\n identity provider as the token's sub (Subject) claim.

" } }, "AssumedRoleUser": { "target": "com.amazonaws.sts#AssumedRoleUser", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

" } }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#deprecated": { "since": "2026-06-17", "message": "Deprecated. Replaced by SessionTokenUtilization." }, "smithy.api#documentation": "

The percentage (0-100) of the maximum allowed session token size that the returned\n session token consumes.

\n

This field is deprecated. Use SessionTokenUtilization instead.

" } }, "Provider": { "target": "com.amazonaws.sts#Issuer", "traits": { "smithy.api#documentation": "

The issuing authority of the web identity token presented. For OpenID Connect ID\n tokens, this contains the value of the iss field. For OAuth 2.0 access tokens,\n this contains the value of the ProviderId parameter that was passed in the\n AssumeRoleWithWebIdentity request.

" } }, "Audience": { "target": "com.amazonaws.sts#Audience", "traits": { "smithy.api#documentation": "

The intended audience (also known as client ID) of the web identity token. This is\n traditionally the client identifier issued to the application that requested the web\n identity token.

" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The value of the source identity that is returned in the JSON web token (JWT) from the\n identity provider.

\n

You can require users to set a source identity value when they assume a role. You do\n this by using the sts:SourceIdentity condition key in a role trust policy.\n That way, actions that are taken with the role are associated with that user. After the\n source identity is set, the value cannot be changed. It is present in the request for all\n actions that are taken by the role and persists across chained role\n sessions. You can configure your identity provider to use an attribute associated with your\n users, like user name or email, as the source identity when calling\n AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web\n token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide.\n For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" }, "TrustedIdentityPropagationContext": { "target": "com.amazonaws.sts#TrustedIdentityPropagationContext", "traits": { "smithy.api#documentation": "

The trusted identity propagation context that Amazon Web Services STS set in the\n session from the web identity token, through the context provider attached to the OpenID\n Connect identity provider. It is present only when Amazon Web Services STS set such\n context in the session. It contains the aws:OriginIdentity/Subject,\n aws:OriginIdentity/SubjectType, aws:OriginIdentity/Issuer and\n aws:OriginIdentity/FederatedProviderArn keys and the\n aws:TransactionContext/IdentityProvider/* keys that Amazon Web Services STS\n set in the session. Other keys in the session, such as\n aws:IdentityCenterInstanceArn and aws:IdentityStoreArn for an\n identity provider with an Identity Center instance attached, are not returned.

\n

This element contains information about the end user. Do not log it.

" } } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful AssumeRoleWithWebIdentity\n request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

", "smithy.api#output": {} } }, "com.amazonaws.sts#AssumeRoot": { "type": "operation", "input": { "target": "com.amazonaws.sts#AssumeRootRequest" }, "output": { "target": "com.amazonaws.sts#AssumeRootResponse" }, "errors": [ { "target": "com.amazonaws.sts#ExpiredTokenException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#documentation": "

Returns a set of short term credentials you can use to perform privileged tasks on a\n member account in your organization. You must use credentials from an Organizations management\n account or a delegated administrator account for IAM to call AssumeRoot. You\n cannot use root user credentials to make this call.

\n

Before you can launch a privileged session, you must have centralized root access in\n your organization. For steps to enable this feature, see Centralize root access for\n member accounts in the IAM User Guide.

\n \n

The STS global endpoint is not supported for AssumeRoot. You must send this request\n to a Regional STS endpoint. For more information, see Endpoints.

\n
\n

You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a\n session. For more information, see Track privileged tasks\n in CloudTrail in the IAM User Guide.

\n

When granting access to privileged tasks you should only grant the necessary permissions\n required to perform that task. For more information, see Security best practices in\n IAM. In addition, you can use service control\n policies (SCPs) to manage and limit permissions in your organization. See General examples in the Organizations User\n Guide for more information on SCPs.

", "smithy.api#examples": [ { "title": "To launch a privileged session", "documentation": "The following command retrieves a set of short-term credentials you can use to unlock an S3 bucket for a member account by removing the bucket policy.", "input": { "TargetPrincipal": "111122223333", "TaskPolicyArn": { "arn": "arn:aws:iam::aws:policy/root-task/S3UnlockBucketPolicy" }, "DurationSeconds": 900 }, "output": { "Credentials": { "SecretAccessKey": "9drTJvcXLB89EXAMPLELB8923FB892xMFI", "SessionToken": "AQoXdzELDDY//////////wEaoAK1wvxJY12r2IrDFT2IvAzTCn3zHoZ7YNtpiQLF0MqZye/qwjzP2iEXAMPLEbw/m3hsj8VBTkPORGvr9jM5sgP+w9IZWZnU+LWhmg+a5fDi2oTGUYcdg9uexQ4mtCHIHfi4citgqZTgco40Yqr4lIlo4V2b2Dyauk0eYFNebHtYlFVgAUj+7Indz3LU0aTWk1WKIjHmmMCIoTkyYp/k7kUG7moeEYKSitwQIi6Gjn+nyzM+PtoA3685ixzv0R7i5rjQi0YE0lf1oeie3bDiNHncmzosRM6SFiPzSvp6h/32xQuZsjcypmwsPSDtTPYcs0+YN/8BRi2/IcrxSpnWEXAMPLEXSDFTAQAM6Dl9zR0tXoybnlrZIwMLlMi1Kcgo5OytwU=", "Expiration": "2024-11-15T00:05:07Z", "AccessKeyId": "ASIAJEXAMPLEXEG2JICEA" }, "SourceIdentity": "Alice" } } ] } }, "com.amazonaws.sts#AssumeRootRequest": { "type": "structure", "members": { "TargetPrincipal": { "target": "com.amazonaws.sts#TargetPrincipalType", "traits": { "smithy.api#documentation": "

The member account principal ARN or account ID.

", "smithy.api#required": {} } }, "TaskPolicyArn": { "target": "com.amazonaws.sts#PolicyDescriptorType", "traits": { "smithy.api#documentation": "

The identity based policy that scopes the session to the privileged tasks that can be\n performed. You must\n \n use one of following Amazon Web Services managed policies to scope root session\n actions:

\n ", "smithy.api#required": {} } }, "DurationSeconds": { "target": "com.amazonaws.sts#RootDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, of the privileged session. The value can range from 0 seconds\n up to the maximum session duration of 900 seconds (15 minutes). If you specify a value\n higher than this setting, the operation fails.

\n

By default, the value is set to 900 seconds.

" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#AssumeRootResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The source identity specified by the principal that is calling the\n AssumeRoot operation.

\n

You can use the aws:SourceIdentity condition key to control access based on\n the value of source identity. For more information about using source identity, see Monitor and control\n actions taken with assumed roles in the\n IAM User Guide.

\n

The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sts#AssumedRoleUser": { "type": "structure", "members": { "AssumedRoleId": { "target": "com.amazonaws.sts#assumedRoleIdType", "traits": { "smithy.api#documentation": "

A unique identifier that contains the role ID and the role session name of the role that\n is being assumed. The role ID is generated by Amazon Web Services when the role is created.

", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in\n policies, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.sts#Audience": { "type": "string" }, "com.amazonaws.sts#Credentials": { "type": "structure", "members": { "AccessKeyId": { "target": "com.amazonaws.sts#accessKeyIdType", "traits": { "smithy.api#documentation": "

The access key ID that identifies the temporary security credentials.

", "smithy.api#required": {} } }, "SecretAccessKey": { "target": "com.amazonaws.sts#accessKeySecretType", "traits": { "smithy.api#documentation": "

The secret access key that can be used to sign requests.

", "smithy.api#required": {} } }, "SessionToken": { "target": "com.amazonaws.sts#tokenType", "traits": { "smithy.api#documentation": "

The token that users must pass to the service API to use the temporary\n credentials.

", "smithy.api#required": {} } }, "Expiration": { "target": "com.amazonaws.sts#dateType", "traits": { "smithy.api#documentation": "

The date on which the current credentials expire.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Amazon Web Services credentials for API authentication.

" } }, "com.amazonaws.sts#DecodeAuthorizationMessage": { "type": "operation", "input": { "target": "com.amazonaws.sts#DecodeAuthorizationMessageRequest" }, "output": { "target": "com.amazonaws.sts#DecodeAuthorizationMessageResponse" }, "errors": [ { "target": "com.amazonaws.sts#InvalidAuthorizationMessageException" } ], "traits": { "smithy.api#documentation": "

Decodes additional information about the authorization status of a request from an\n encoded message returned in response to an Amazon Web Services request.

\n

For example, if a user is not authorized to perform an operation that he or she has\n requested, the request returns a Client.UnauthorizedOperation response (an\n HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can\n provide details about this authorization failure.

\n \n

Only certain Amazon Web Services operations return an encoded authorization message. The\n documentation for an individual operation indicates whether that operation returns an\n encoded message in addition to returning an HTTP code.

\n
\n

The message is encoded because the details of the authorization status can contain\n privileged information that the user who requested the operation should not see. To decode\n an authorization status message, a user must be granted permissions through an IAM policy to\n request the DecodeAuthorizationMessage\n (sts:DecodeAuthorizationMessage) action.

\n

The decoded message includes the following type of information:

\n ", "smithy.api#examples": [ { "title": "To decode information about an authorization status of a request", "documentation": "", "input": { "EncodedMessage": "" }, "output": { "DecodedMessage": "{\"allowed\": \"false\",\"explicitDeny\": \"false\",\"matchedStatements\": \"\",\"failures\": \"\",\"context\": {\"principal\": {\"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\"name\": \"Bob\",\"arn\": \"arn:aws:iam::123456789012:user/Bob\"},\"action\": \"ec2:StopInstances\",\"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\"conditions\": [{\"item\": {\"key\": \"ec2:Tenancy\",\"values\": [\"default\"]},{\"item\": {\"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\"values\": [\"Default-Environment\"]}},(Additional items ...)]}}" } } ] } }, "com.amazonaws.sts#DecodeAuthorizationMessageRequest": { "type": "structure", "members": { "EncodedMessage": { "target": "com.amazonaws.sts#encodedMessageType", "traits": { "smithy.api#documentation": "

The encoded message that was returned with the response.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#DecodeAuthorizationMessageResponse": { "type": "structure", "members": { "DecodedMessage": { "target": "com.amazonaws.sts#decodedMessageType", "traits": { "smithy.api#documentation": "

The API returns a response with the decoded message.

" } } }, "traits": { "smithy.api#documentation": "

A document that contains additional information about the authorization status of a\n request from an encoded message that is returned in response to an Amazon Web Services request.

", "smithy.api#output": {} } }, "com.amazonaws.sts#ExpiredTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#expiredIdentityTokenMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ExpiredTokenException", "httpResponseCode": 400 }, "smithy.api#documentation": "

The web identity token that was passed is expired or is not valid. Get a new identity\n token from the identity provider and then retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#ExpiredTradeInTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#expiredTradeInTokenExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ExpiredTradeInTokenException", "httpResponseCode": 400 }, "smithy.api#documentation": "

The trade-in token provided in the request has expired and can no longer be exchanged\n for credentials. Request a new token and retry the operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#FederatedUser": { "type": "structure", "members": { "FederatedUserId": { "target": "com.amazonaws.sts#federatedIdType", "traits": { "smithy.api#documentation": "

The string that identifies the federated user associated with the credentials, similar\n to the unique ID of an IAM user.

", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The ARN that specifies the federated user that is associated with the credentials. For\n more information about ARNs and how to use them in policies, see IAM\n Identifiers in the IAM User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifiers for the federated user that is associated with the credentials.

" } }, "com.amazonaws.sts#GetAccessKeyInfo": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetAccessKeyInfoRequest" }, "output": { "target": "com.amazonaws.sts#GetAccessKeyInfoResponse" }, "traits": { "smithy.api#documentation": "

Returns the account identifier for the specified access key ID.

\n

Access keys consist of two parts: an access key ID (for example,\n AKIAIOSFODNN7EXAMPLE) and a secret access key (for example,\n wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about\n access keys, see Managing Access Keys for IAM\n Users in the IAM User Guide.

\n

When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account\n to which the keys belong. Access key IDs beginning with AKIA are long-term\n credentials for an IAM user or the Amazon Web Services account root user. Access key IDs\n beginning with ASIA are temporary credentials that are created using STS\n operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials\n report to learn which IAM user owns the keys. To learn who\n requested the temporary credentials for an ASIA access key, view the STS\n events in your CloudTrail logs in the IAM User Guide.

\n

This operation does not indicate the state of the access key. The key might be active,\n inactive, or deleted. Active keys might not have permissions to perform an operation.\n Providing a deleted access key might return an error that the key doesn't exist.

" } }, "com.amazonaws.sts#GetAccessKeyInfoRequest": { "type": "structure", "members": { "AccessKeyId": { "target": "com.amazonaws.sts#accessKeyIdType", "traits": { "smithy.api#documentation": "

The identifier of an access key.

\n

This parameter allows (through its regex pattern) a string of characters that can\n consist of any upper- or lowercase letter or digit.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetAccessKeyInfoResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.sts#accountType", "traits": { "smithy.api#documentation": "

The number used to identify the Amazon Web Services account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sts#GetCallerIdentity": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetCallerIdentityRequest" }, "output": { "target": "com.amazonaws.sts#GetCallerIdentityResponse" }, "traits": { "smithy.api#documentation": "

Returns details about the IAM user or role whose credentials are used to\n call the operation.

\n \n

No permissions are required to perform this operation. If an administrator attaches a\n policy to your identity that explicitly denies access to the\n sts:GetCallerIdentity action, you can still perform this operation.\n Permissions are not required because the same information is returned when access is\n denied. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the\n IAM User Guide.

\n
", "smithy.api#examples": [ { "title": "To get details about a calling IAM user", "documentation": "This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.", "output": { "UserId": "AKIAI44QH8DHBEXAMPLE", "Account": "123456789012", "Arn": "arn:aws:iam::123456789012:user/Alice" } }, { "title": "To get details about a calling user federated with AssumeRole", "documentation": "This example shows a request and response made with temporary credentials created by AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name.", "output": { "UserId": "AKIAI44QH8DHBEXAMPLE:my-role-session-name", "Account": "123456789012", "Arn": "arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name" } }, { "title": "To get details about a calling user federated with GetFederationToken", "documentation": "This example shows a request and response made with temporary credentials created by using GetFederationToken. The Name parameter is set to my-federated-user-name.", "output": { "UserId": "123456789012:my-federated-user-name", "Account": "123456789012", "Arn": "arn:aws:sts::123456789012:federated-user/my-federated-user-name" } } ] } }, "com.amazonaws.sts#GetCallerIdentityRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetCallerIdentityResponse": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.sts#userIdType", "traits": { "smithy.api#documentation": "

The unique identifier of the calling entity. The exact value depends on the type of\n entity that is making the call. The values returned are those listed in the aws:userid column in the Principal\n table found on the Policy Variables reference\n page in the IAM User Guide.

" } }, "Account": { "target": "com.amazonaws.sts#accountType", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID number of the account that owns or contains the calling\n entity.

" } }, "Arn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Web Services ARN associated with the calling entity.

" } } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful GetCallerIdentity request,\n including information about the entity making the request.

", "smithy.api#output": {} } }, "com.amazonaws.sts#GetDelegatedAccessToken": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetDelegatedAccessTokenRequest" }, "output": { "target": "com.amazonaws.sts#GetDelegatedAccessTokenResponse" }, "errors": [ { "target": "com.amazonaws.sts#ExpiredTradeInTokenException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#documentation": "

Exchanges a trade-in token for temporary Amazon Web Services credentials with the permissions\n associated with the assumed principal. This operation allows you to obtain credentials for\n a specific principal based on a trade-in token, enabling delegation of access to Amazon Web Services\n resources.

" } }, "com.amazonaws.sts#GetDelegatedAccessTokenRequest": { "type": "structure", "members": { "TradeInToken": { "target": "com.amazonaws.sts#tradeInTokenType", "traits": { "smithy.api#documentation": "

The token to exchange for temporary Amazon Web Services credentials. This token must be valid and\n unexpired at the time of the request.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetDelegatedAccessTokenResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials" }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#deprecated": { "since": "2026-06-17", "message": "Deprecated. This field is not populated for GetDelegatedAccessToken." }, "smithy.api#documentation": "

This field is deprecated. It is not populated for\n GetDelegatedAccessToken.

" } }, "AssumedPrincipal": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal that was assumed when obtaining the\n delegated access token. This ARN identifies the IAM entity whose permissions are granted\n by the temporary credentials.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sts#GetFederationToken": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetFederationTokenRequest" }, "output": { "target": "com.amazonaws.sts#GetFederationTokenResponse" }, "errors": [ { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" }, { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#documentation": "

Returns a set of temporary security credentials (consisting of an access key ID, a\n secret access key, and a security token) for a user. A typical use is in a proxy\n application that gets temporary security credentials on behalf of distributed applications\n inside a corporate network.

\n

You must call the GetFederationToken operation using the long-term security\n credentials of an IAM user. As a result, this call is appropriate in\n contexts where those credentials can be safeguarded, usually in a server-based application.\n For a comparison of GetFederationToken with the other API operations that\n produce temporary credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.

\n

Although it is possible to call GetFederationToken using the security\n credentials of an Amazon Web Services account root user rather than an IAM user that you\n create for the purpose of a proxy application, we do not recommend it. For more\n information, see Safeguard your root user credentials and don't use them for everyday tasks in the\n IAM User Guide.

\n \n

You can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.

\n
\n

\n Session duration\n

\n

The temporary credentials are valid for the specified duration, from 900 seconds (15\n minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is\n 43,200 seconds (12 hours). Temporary credentials obtained by using the root user\n credentials have a maximum duration of 3,600 seconds (1 hour).

\n

\n Permissions\n

\n

You can use the temporary credentials created by GetFederationToken in any\n Amazon Web Services service with the following exceptions:

\n \n

You can use temporary credentials for single sign-on (SSO) to the console.

\n

You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters.

\n

Though the session policy parameters are optional, if you do not pass a policy, then the\n resulting federated user session has no permissions. When you pass session policies, the\n session permissions are the intersection of the IAM user policies and the\n session policies that you pass. This gives you a way to further restrict the permissions\n for a federated user. You cannot use session policies to grant more permissions than those\n that are defined in the permissions policy of the IAM user. For more\n information, see Session Policies in\n the IAM User Guide. For information about using\n GetFederationToken to create temporary security credentials, see GetFederationToken\u2014Federation Through a Custom Identity Broker.

\n

You can use the credentials to access a resource that has a resource-based policy. If\n that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions granted by the\n session policies.

\n

\n Tags\n

\n

(Optional) You can pass tag key-value pairs to your session. These are called session\n tags. For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n \n

You can create a mobile-based or browser-based app that can authenticate users using\n a web identity provider like Login with Amazon, Facebook, Google, or an OpenID\n Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or\n AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the\n IAM User Guide.

\n
\n

An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

\n

Tag key\u2013value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the user that you are federating has the\n Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the user tag.

", "smithy.api#examples": [ { "title": "To get temporary credentials for a role by using GetFederationToken", "documentation": "", "input": { "Name": "testFedUserSession", "Policy": "escaped-JSON-IAM-POLICY", "DurationSeconds": 3600, "Tags": [ { "Key": "Project", "Value": "Pegasus" }, { "Key": "Cost-Center", "Value": "98765" } ] }, "output": { "Credentials": { "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "Expiration": "2011-07-15T23:28:33.359Z", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" }, "FederatedUser": { "Arn": "arn:aws:sts::123456789012:federated-user/Bob", "FederatedUserId": "123456789012:Bob" }, "PackedPolicySize": 8 } } ] } }, "com.amazonaws.sts#GetFederationTokenRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.sts#userNameType", "traits": { "smithy.api#documentation": "

The name of the federated user. The name is used as an identifier for the temporary\n security credentials (such as Bob). For example, you can reference the\n federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

\n

The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { "smithy.api#documentation": "

An IAM policy in JSON format that you want to use as an inline session policy.

\n

You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies.

\n

This parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.

\n

When you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you\n a way to further restrict the permissions for a federated user. You cannot use session\n policies to grant more permissions than those that are defined in the permissions policy of\n the IAM user. For more information, see Session Policies in\n the IAM User Guide.

\n

The resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.

\n

The plaintext that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

" } }, "PolicyArns": { "target": "com.amazonaws.sts#policyDescriptorListType", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a\n managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.

\n

You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as\n managed session policies. The plaintext that you use for both inline and managed session\n policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For\n more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

\n

This parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.

\n

When you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you\n a way to further restrict the permissions for a federated user. You cannot use session\n policies to grant more permissions than those that are defined in the permissions policy of\n the IAM user. For more information, see Session Policies in\n the IAM User Guide.

\n

The resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.

" } }, "DurationSeconds": { "target": "com.amazonaws.sts#durationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the session should last. Acceptable durations for\n federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with\n 43,200 seconds (12 hours) as the default. Sessions obtained using root user\n credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified\n duration is longer than one hour, the session obtained by using root user\n credentials defaults to one hour.

" } }, "Tags": { "target": "com.amazonaws.sts#tagListType", "traits": { "smithy.api#documentation": "

A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

\n

This parameter is optional. You can pass up to 50 session tags. The plaintext session\n tag keys can\u2019t exceed 128 characters and the values can\u2019t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

\n

You can pass a session tag with the same key as a tag that is already attached to the\n user you are federating. When you do, session tags override a user tag with the same key.

\n

Tag key\u2013value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetFederationTokenResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "FederatedUser": { "target": "com.amazonaws.sts#FederatedUser", "traits": { "smithy.api#documentation": "

Identifiers for the federated user associated with the credentials (such as\n arn:aws:sts::123456789012:federated-user/Bob or\n 123456789012:Bob). You can use the federated user's ARN in your\n resource-based policies, such as an Amazon S3 bucket policy.

" } }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#deprecated": { "since": "2026-06-17", "message": "Deprecated. Replaced by SessionTokenUtilization." }, "smithy.api#documentation": "

The percentage (0-100) of the maximum allowed session token size that the returned\n session token consumes.

\n

This field is deprecated. Use SessionTokenUtilization instead.

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful GetFederationToken request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

", "smithy.api#output": {} } }, "com.amazonaws.sts#GetScopedCredentials": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetScopedCredentialsRequest" }, "output": { "target": "com.amazonaws.sts#GetScopedCredentialsResponse" }, "errors": [ { "target": "com.amazonaws.sts#InsufficientSessionLifetimeException" }, { "target": "com.amazonaws.sts#InvalidSubjectCredentialsException" }, { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.sts#PackedPolicyTooLargeException" } ], "traits": { "smithy.api#documentation": "

Returns a set of temporary security credentials that are scoped down from the caller's\n existing temporary security credentials. GetScopedCredentials preserves the\n caller's identity while narrowing the permissions and optionally shortening the session\n lifetime.

\n

For a comparison of GetScopedCredentials with the other API operations that\n produce temporary security credentials, see Requesting Temporary Security\n Credentials and Compare STS\n credentials in the IAM User Guide.

\n

\n Credential requirements\n

\n

You can only call GetScopedCredentials with temporary security credentials,\n for example, credentials from an assumed role or a federated session. You cannot call it\n with IAM user credentials or root credentials. If you want to scope down IAM user\n credentials, first call GetSessionToken to get temporary security credentials,\n and then call GetScopedCredentials with those credentials.

\n \n

The GetScopedCredentials API is not available on the STS Global\n endpoint.

\n
", "smithy.api#examples": [ { "title": "To scope down existing temporary credentials", "documentation": "", "input": { "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::example-bucket/*\"}]}", "DurationSeconds": 3600 }, "output": { "Credentials": { "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "SessionToken": "AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE", "Expiration": "2011-07-15T23:28:33.359Z" }, "SessionInfo": { "ScopedSessionId": "AROAEXAMPLEID:example-session", "Arn": "arn:aws:sts::123456789012:assumed-role/example-role/example-session" }, "ScopedPoliciesCount": 1, "SourceIdentity": "example-source-identity" } } ] } }, "com.amazonaws.sts#GetScopedCredentialsRequest": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { "smithy.api#documentation": "

An IAM policy in JSON format that you want to use as a scope down policy.

\n

A request must provide at least one of Policy or DurationSeconds.\n Both parameters are optional individually, but you must specify at least one of them.

\n

The resulting session's permissions are the intersection of the calling session's existing\n permissions and this scope down policy. You cannot use this scope down policy to grant more\n permissions than the calling session already has.

\n

The plaintext of the scope down policy cannot exceed 2,048 characters. The JSON policy\n characters can be any ASCII character from the space character to the end of the valid\n character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed\n (\\u000A), and carriage return (\\u000D) characters.

\n \n

An internal conversion compresses the inline scope down policy into a packed binary\n format that has a separate limit. If the packed policy exceeds this limit, the request fails\n with PackedPolicyTooLarge.

\n

If the document is not valid IAM policy JSON, the request fails with\n MalformedPolicyDocument.

\n
" } }, "DurationSeconds": { "target": "com.amazonaws.sts#scopedCredentialDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, of the resulting scoped down credentials. The value can range\n from 1 second to 129,600 seconds (36 hours).

\n

If you do not specify this value, the scoped down credentials will inherit the calling\n session's expiration time.

" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" }, "ScopedSessionDescription": { "target": "com.amazonaws.sts#scopedSessionDescriptionType", "traits": { "smithy.api#documentation": "

A caller-supplied description of the scoped session. The value cannot exceed 256\n characters. This description is logged to CloudTrail for the request, so you can use it to\n record the purpose of the scoped session.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetScopedCredentialsResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials for the scoped down session, which include an access\n key ID, a secret access key, and a security token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "SessionInfo": { "target": "com.amazonaws.sts#ScopedSession", "traits": { "smithy.api#documentation": "

Metadata about the resulting scoped session, including its identifier and ARN. Because the\n identity does not change, the identifiers reflect the same principal and session name as the\n calling session.

" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" }, "ScopedPoliciesCount": { "target": "com.amazonaws.sts#scopedPoliciesCountType", "traits": { "smithy.api#documentation": "

\n GetScopedCredentials can be called recursively and\n ScopedPoliciesCount specifies the number of scope down policies applied to the\n session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down\n policy layers are allowed per session. If a session already has 3\n GetScopedCredentials scope-down policies, a subsequent\n GetScopedCredentials call that supplies a Policy (attempting to\n append a fourth scope-down policy) is denied.

" } }, "SourceIdentity": { "target": "com.amazonaws.sts#sourceIdentityType", "traits": { "smithy.api#documentation": "

The source identity of the calling session, carried forward unchanged. This operation\n never sets or modifies the source identity; it reflects the value established when the source\n identity was first set. For more information, see Monitor and control\n actions taken with assumed roles in the IAM User Guide.

" } } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful GetScopedCredentials request,\n including the scoped-down temporary Amazon Web Services credentials and metadata about the resulting\n session.

", "smithy.api#output": {} } }, "com.amazonaws.sts#GetSessionToken": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetSessionTokenRequest" }, "output": { "target": "com.amazonaws.sts#GetSessionTokenResponse" }, "errors": [ { "target": "com.amazonaws.sts#RegionDisabledException" } ], "traits": { "smithy.api#documentation": "

Returns a set of temporary credentials for an Amazon Web Services account or IAM user.\n The credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2\n StopInstances.

\n

MFA-enabled IAM users must call GetSessionToken and submit\n an MFA code that is associated with their MFA device. Using the temporary security\n credentials that the call returns, IAM users can then make programmatic\n calls to API operations that require MFA authentication. An incorrect MFA code causes the\n API to return an access denied error. For a comparison of GetSessionToken with\n the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Compare STS\n credentials in the IAM User Guide.

\n \n

No permissions are required for users to perform this operation. The purpose of the\n sts:GetSessionToken operation is to authenticate the user using MFA. You\n cannot use policies to control authentication operations. For more information, see\n Permissions for GetSessionToken in the\n IAM User Guide.

\n
\n

\n Session Duration\n

\n

The GetSessionToken operation must be called by using the long-term Amazon Web Services\n security credentials of an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.

\n

\n Permissions\n

\n

The temporary security credentials created by GetSessionToken can be used\n to make API calls to any Amazon Web Services service with the following exceptions:

\n \n

The credentials that GetSessionToken returns are based on permissions\n associated with the IAM user whose credentials were used to call the\n operation. The temporary credentials have the same permissions as the IAM user.

\n \n

Although it is possible to call GetSessionToken using the security\n credentials of an Amazon Web Services account root user rather than an IAM user, we do\n not recommend it. If GetSessionToken is called using root user\n credentials, the temporary credentials have root user permissions. For more\n information, see Safeguard your root user credentials and don't use them for everyday tasks in the\n IAM User Guide\n

\n
\n

For more information about using GetSessionToken to create temporary\n credentials, see Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.

", "smithy.api#examples": [ { "title": "To get temporary credentials for an IAM user or an AWS account", "documentation": "", "input": { "DurationSeconds": 3600, "SerialNumber": "YourMFASerialNumber", "TokenCode": "123456" }, "output": { "Credentials": { "SessionToken": "AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "Expiration": "2011-07-11T19:55:29.611Z", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" } } } ] } }, "com.amazonaws.sts#GetSessionTokenRequest": { "type": "structure", "members": { "DurationSeconds": { "target": "com.amazonaws.sts#durationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the credentials should remain valid. Acceptable durations\n for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds\n (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account\n owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer\n than one hour, the session for Amazon Web Services account owners defaults to one hour.

" } }, "SerialNumber": { "target": "com.amazonaws.sts#serialNumberType", "traits": { "smithy.api#documentation": "

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value\n if the IAM user has a policy that requires MFA authentication. The value is\n either the serial number for a hardware device (such as GAHT12345678) or an\n Amazon Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security credentials.

\n

The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-

" } }, "TokenCode": { "target": "com.amazonaws.sts#tokenCodeType", "traits": { "smithy.api#documentation": "

The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication\n is required, the user must provide a code when requesting a set of temporary security\n credentials. A user who fails to provide the code receives an \"access denied\" response when\n requesting resources that require MFA authentication.

\n

The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.

" } }, "MinimumSessionTokenSize": { "target": "com.amazonaws.sts#minimumSessionTokenSizeType" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetSessionTokenResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { "smithy.api#documentation": "

The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

\n \n

The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

\n
" } }, "SessionTokenUtilization": { "target": "com.amazonaws.sts#sessionTokenUtilizationType" }, "SessionTokenSize": { "target": "com.amazonaws.sts#sessionTokenSizeType" } }, "traits": { "smithy.api#documentation": "

Contains the response to a successful GetSessionToken request,\n including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

", "smithy.api#output": {} } }, "com.amazonaws.sts#GetWebIdentityToken": { "type": "operation", "input": { "target": "com.amazonaws.sts#GetWebIdentityTokenRequest" }, "output": { "target": "com.amazonaws.sts#GetWebIdentityTokenResponse" }, "errors": [ { "target": "com.amazonaws.sts#JWTPayloadSizeExceededException" }, { "target": "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException" }, { "target": "com.amazonaws.sts#SessionDurationEscalationException" } ], "traits": { "smithy.api#documentation": "

Returns a signed JSON Web Token (JWT) that represents the calling Amazon Web Services identity or, if you set\n SubjectMode to OriginIdentity, the human user or workload on whose behalf the\n calling session acts. The returned JWT can be used to authenticate with external services that support OIDC discovery.\n The token is signed by Amazon Web Services STS and can be publicly verified using the verification keys published at the issuer's JWKS endpoint.

\n

The sub (subject) claim contains the identity that SubjectMode selects. Whichever\n subject mode you use, the principal_id claim under the https://sts.amazonaws.com/\n namespace contains the ARN of the principal that requested the token, when that principal has an ARN. For a\n role session, this is the ARN of the role.

\n \n

The GetWebIdentityToken API is not available on the STS Global endpoint.

\n
" } }, "com.amazonaws.sts#GetWebIdentityTokenRequest": { "type": "structure", "members": { "Audience": { "target": "com.amazonaws.sts#webIdentityTokenAudienceListType", "traits": { "smithy.api#documentation": "

The intended recipient of the web identity token. This value populates the\n aud claim in the JWT and should identify the service or application that\n will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.

", "smithy.api#required": {} } }, "DurationSeconds": { "target": "com.amazonaws.sts#webIdentityTokenDurationSecondsType", "traits": { "smithy.api#documentation": "

The duration, in seconds, for which the JSON Web Token (JWT) will remain valid. \n The value can range from 60 seconds (1 minute) to 3600 seconds (1 hour). If not specified, \n the default duration is 300 seconds (5 minutes). The token is designed to be short-lived and \n should be used for proof of identity, then exchanged for credentials or short-lived tokens in the external service.

" } }, "SigningAlgorithm": { "target": "com.amazonaws.sts#jwtAlgorithmType", "traits": { "smithy.api#documentation": "

The cryptographic algorithm to use for signing the JSON Web Token (JWT). Valid values are \n RS256 (RSA with SHA-256) and ES384 (ECDSA using P-384 curve with SHA-384).

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.sts#webIdentityTokenScopeType", "traits": { "smithy.api#documentation": "

One or more OAuth 2.0 scope values to include in the JSON Web Token (JWT). Amazon Web Services STS copies the\n value exactly as you send it into the top-level scope claim of the token. If you don't\n specify Scope, the token doesn't include a scope claim.

\n

Separate multiple values with a single space, as defined in RFC 6749, section 3.3 on the IETF\n website. Don't begin or end Scope with a space. Each scope value can contain printable\n ASCII characters except spaces, double quotation marks (\"), commas (,), and\n backslashes (\\).

\n

You can't repeat a scope value. Scope values are case sensitive. This means that\n read and READ are separate values.

\n

You can specify Scope only when SubjectMode is OriginIdentity\n and you request exactly one audience. To specify Scope, the calling principal must have\n permission for the sts:SetWebIdentityTokenScope action in addition to\n sts:GetWebIdentityToken. You can use the multivalued\n sts:IdentityTokenScope condition key in a policy to control which scope values a principal\n can request.

" } }, "SubjectMode": { "target": "com.amazonaws.sts#webIdentityTokenSubjectModeType", "traits": { "smithy.api#documentation": "

Specifies which identity STS puts in the sub (subject) claim of the JSON Web Token\n (JWT). Valid values are AWSIdentity and OriginIdentity. If you don't specify a\n value, Amazon Web Services STS uses AWSIdentity.

\n \n

You can use the sts:SubjectMode condition key in a policy to control which subject\n modes a principal can request.

" } }, "Tags": { "target": "com.amazonaws.sts#tagListType", "traits": { "smithy.api#documentation": "

An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom \n claims to the JWT and can be used by the downstream service for authorization decisions.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sts#GetWebIdentityTokenResponse": { "type": "structure", "members": { "WebIdentityToken": { "target": "com.amazonaws.sts#webIdentityTokenType", "traits": { "smithy.api#documentation": "

A signed JSON Web Token (JWT) that represents the caller's Amazon Web Services identity or, if you set\n SubjectMode to OriginIdentity, the human user or workload on whose behalf the\n calling session acts. The token contains\n standard JWT claims such as subject, audience, expiration time, and additional identity attributes\n added by STS as custom claims. These can include the principal_id claim, which contains the ARN of\n the principal that requested the token, whichever subject mode you use. You can also add your own custom claims to the token by passing tags\n as request parameters to the GetWebIdentityToken API. The token is signed using the specified signing \n algorithm and can be verified using the verification keys available at the issuer's JWKS endpoint.

" } }, "Expiration": { "target": "com.amazonaws.sts#dateType", "traits": { "smithy.api#documentation": "

The date and time when the web identity token expires, in UTC. The expiration is\n determined by adding the DurationSeconds value to the time the token was\n issued. After this time, the token should no longer be considered valid.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sts#IDPCommunicationErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#idpCommunicationErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "IDPCommunicationError", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request could not be fulfilled because the identity provider (IDP) that was asked\n to verify the incoming identity token could not be reached. This is often a transient\n error caused by network conditions. Retry the request a limited number of times so that\n you don't exceed the request rate. If the error persists, the identity provider might be\n down or not responding.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#IDPRejectedClaimException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#idpRejectedClaimMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "IDPRejectedClaim", "httpResponseCode": 403 }, "smithy.api#documentation": "

The identity provider (IdP) reported that authentication failed. This might be because\n the claim is invalid.

\n

If this error is returned for the AssumeRoleWithWebIdentity operation, it\n can also mean that the claim has expired or has been explicitly revoked.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sts#InsufficientSessionLifetimeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#insufficientSessionLifetimeMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InsufficientSessionLifetime", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request was rejected because the requested DurationSeconds is greater\n than the remaining lifetime of the calling session. GetScopedCredentials\n cannot extend a session beyond its original expiration. Request a duration that is less\n than or equal to the calling session's remaining lifetime, or omit\n DurationSeconds to inherit it.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#InvalidAuthorizationMessageException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#invalidAuthorizationMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidAuthorizationMessageException", "httpResponseCode": 400 }, "smithy.api#documentation": "

The error returned if the message passed to DecodeAuthorizationMessage\n was invalid. This can happen if the token contains invalid characters, such as line\n breaks, or if the message has expired.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#InvalidContextAssertionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#InvalidContextAssertionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidContextAssertion", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request was rejected because the context assertion that was provided is invalid.\n This can happen if the context assertion supplied in the ProvidedContexts\n parameter is malformed, has expired, or does not match a trusted context provider.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#InvalidContextAssertionMessage": { "type": "string" }, "com.amazonaws.sts#InvalidIdentityTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#invalidIdentityTokenMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidIdentityToken", "httpResponseCode": 400 }, "smithy.api#documentation": "

The web identity token that was passed could not be validated by Amazon Web Services. Get a new\n identity token from the identity provider and then retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#InvalidSubjectCredentialsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#InvalidSubjectCredentialsMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSubjectCredentials", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request was rejected because the session used to call\n GetScopedCredentials is not a valid session. The calling session's credentials\n could not be validated or resolved.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#InvalidSubjectCredentialsMessage": { "type": "string" }, "com.amazonaws.sts#Issuer": { "type": "string" }, "com.amazonaws.sts#JWTPayloadSizeExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#JWTPayloadSizeExceededException2" } }, "traits": { "aws.protocols#awsQueryError": { "code": "JWTPayloadSizeExceededException", "httpResponseCode": 400 }, "smithy.api#documentation": "

The requested token payload size exceeds the maximum allowed size. Reduce the number of request tags included in the GetWebIdentityToken API call to reduce the token payload size.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#JWTPayloadSizeExceededException2": { "type": "string" }, "com.amazonaws.sts#MalformedPolicyDocumentException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#malformedPolicyDocumentMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "MalformedPolicyDocument", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#NameQualifier": { "type": "string" }, "com.amazonaws.sts#OriginIdentity": { "type": "structure", "members": { "Subject": { "target": "com.amazonaws.sts#originIdentitySubjectType", "traits": { "smithy.api#documentation": "

The value of the aws:OriginIdentity/Subject key: the end user's identifier,\n taken from the token claim that the context provider maps as the subject.

" } }, "SubjectType": { "target": "com.amazonaws.sts#originIdentitySubjectTypeType", "traits": { "smithy.api#documentation": "

The value of the aws:OriginIdentity/SubjectType key, which indicates whether\n the end user is a person (user) or a non-human caller such as an application\n or service (workload).

" } }, "Issuer": { "target": "com.amazonaws.sts#originIdentityIssuerType", "traits": { "smithy.api#documentation": "

The value of the aws:OriginIdentity/Issuer key. For\n AssumeRoleWithWebIdentity, this is the iss claim of the token\n without the https:// prefix. For AssumeRoleWithSAML, this is a\n hash of the key that signed the SAML assertion, not the Issuer element of the\n assertion.

" } }, "FederatedProviderArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The value of the aws:OriginIdentity/FederatedProviderArn key: the ARN of\n the IAM identity provider that the request federated through.

" } } }, "traits": { "smithy.api#documentation": "

The session's aws:OriginIdentity/Subject,\n aws:OriginIdentity/SubjectType, aws:OriginIdentity/Issuer and\n aws:OriginIdentity/FederatedProviderArn keys. A member is absent when the\n session does not have the key.

" } }, "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException2" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OutboundWebIdentityFederationDisabledException", "httpResponseCode": 403 }, "smithy.api#documentation": "

The outbound web identity federation feature is not enabled for this account. To use\n this feature, you must first enable it through the Amazon Web Services Management Console or API.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sts#OutboundWebIdentityFederationDisabledException2": { "type": "string" }, "com.amazonaws.sts#PackedPolicyTooLargeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#packedPolicyTooLargeMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "PackedPolicyTooLarge", "httpResponseCode": 400 }, "smithy.api#documentation": "

The request was rejected because the session token exceeded the maximum allowed size.\n The error message reports the session token size and the maximum allowed size, both in\n bytes. Session policies and session tags add to the session token size. For more\n information, see Passing Session Tags in STS in\n the IAM User Guide.

\n

You might receive this error even though you meet the individual session policy and\n session tag limits. Monitor SessionTokenUtilization to track how close the\n session token is to the maximum allowed size. For more information, see IAM and STS Entity Character Limits in the IAM User\n Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sts#PolicyDescriptorType": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy\n for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services\n Service Namespaces in the Amazon Web Services General Reference.

" } } }, "traits": { "smithy.api#documentation": "

A reference to the IAM managed policy that is passed as a session policy for a role\n session or a federated user session.

" } }, "com.amazonaws.sts#ProvidedContext": { "type": "structure", "members": { "ProviderArn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The context provider ARN from which the trusted context assertion was generated.

" } }, "ContextAssertion": { "target": "com.amazonaws.sts#contextAssertionType", "traits": { "smithy.api#documentation": "

The signed and encrypted trusted context assertion generated by the context provider.\n The trusted context assertion is signed and encrypted by Amazon Web Services STS.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the provided context. This includes the signed and encrypted\n trusted context assertion and the context provider ARN from which the trusted context\n assertion was generated.

" } }, "com.amazonaws.sts#ProvidedContextsListType": { "type": "list", "member": { "target": "com.amazonaws.sts#ProvidedContext" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.sts#RegionDisabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#regionDisabledMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RegionDisabledException", "httpResponseCode": 403 }, "smithy.api#documentation": "

STS is not activated in the requested region for the account that is being asked to\n generate credentials. The account administrator must use the IAM console to activate\n STS in that region. For more information, see Activating and Deactivating STS in an Amazon Web Services Region in the IAM\n User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sts#RootDurationSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 900 } } }, "com.amazonaws.sts#SAMLAssertionType": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 100000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.sts#ScopedSession": { "type": "structure", "members": { "ScopedSessionId": { "target": "com.amazonaws.sts#scopedSessionIdType", "traits": { "smithy.api#documentation": "

A unique identifier for the scoped session. Because the identity is preserved, this\n identifies the same principal as the calling session.

", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.sts#arnType", "traits": { "smithy.api#documentation": "

The ARN of the scoped session. For more information about ARNs and how to use them in\n policies, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifiers for the scoped session that GetScopedCredentials returns. The\n underlying identity and session name do not change from the caller principal.

" } }, "com.amazonaws.sts#SessionDurationEscalationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sts#SessionDurationEscalationException2" } }, "traits": { "aws.protocols#awsQueryError": { "code": "SessionDurationEscalationException", "httpResponseCode": 403 }, "smithy.api#documentation": "

The requested token duration would extend the session beyond its original expiration time. \n You cannot use this operation to extend the lifetime of a session beyond what was granted when the session was originally created.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sts#SessionDurationEscalationException2": { "type": "string" }, "com.amazonaws.sts#Subject": { "type": "string" }, "com.amazonaws.sts#SubjectType": { "type": "string" }, "com.amazonaws.sts#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.sts#tagKeyType", "traits": { "smithy.api#documentation": "

The key for a session tag.

\n

You can pass up to 50 session tags. The plain text session tag keys can\u2019t exceed 128\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.sts#tagValueType", "traits": { "smithy.api#documentation": "

The value for a session tag.

\n

You can pass up to 50 session tags. The plain text session tag values can\u2019t exceed 256\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You can pass custom key-value pair attributes when you assume a role or federate a user.\n These are called session tags. You can then use the session tags to control access to\n resources. For more information, see Tagging Amazon Web Services STS Sessions in the\n IAM User Guide.

" } }, "com.amazonaws.sts#TargetPrincipalType": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 2048 } } }, "com.amazonaws.sts#TransactionContext": { "type": "structure", "members": { "IdentityProvider": { "target": "com.amazonaws.sts#transactionContextIdentityProviderMapType", "traits": { "smithy.api#documentation": "

The session's aws:TransactionContext/IdentityProvider/* keys, keyed by the\n part of the key name after aws:TransactionContext/IdentityProvider/. Each\n value is up to 128 characters.

\n

The number of entries is bounded twice. IAM limits how many keys a context provider\n maps when you configure it on the identity provider, and Amazon Web Services STS rejects a\n session whose session token exceeds the maximum size with\n PackedPolicyTooLarge.

" } } }, "traits": { "smithy.api#documentation": "

The session's aws:TransactionContext/IdentityProvider/* keys.

" } }, "com.amazonaws.sts#TrustedIdentityPropagationContext": { "type": "structure", "members": { "OriginIdentity": { "target": "com.amazonaws.sts#OriginIdentity", "traits": { "smithy.api#documentation": "

The identity of the end user on whose behalf the session acts.

" } }, "TransactionContext": { "target": "com.amazonaws.sts#TransactionContext", "traits": { "smithy.api#documentation": "

Additional claims about the request that the identity provider asserted.

" } } }, "traits": { "smithy.api#documentation": "

The trusted identity propagation context that Amazon Web Services STS set in a session\n from the identity provider's token. A member is absent when the session has none of its\n keys.

", "smithy.api#sensitive": {} } }, "com.amazonaws.sts#accessKeyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 16, "max": 128 }, "smithy.api#pattern": "^[\\w]*$" } }, "com.amazonaws.sts#accessKeySecretType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.sts#accountType": { "type": "string" }, "com.amazonaws.sts#arnType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+$" } }, "com.amazonaws.sts#assumedRoleIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 193 }, "smithy.api#pattern": "^[\\w+=,.@:-]*$" } }, "com.amazonaws.sts#clientTokenType": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 20000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.sts#contextAssertionType": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 3072 } } }, "com.amazonaws.sts#dateType": { "type": "timestamp" }, "com.amazonaws.sts#decodedMessageType": { "type": "string" }, "com.amazonaws.sts#durationSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 900, "max": 129600 } } }, "com.amazonaws.sts#encodedMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10240 } } }, "com.amazonaws.sts#expiredIdentityTokenMessage": { "type": "string" }, "com.amazonaws.sts#expiredTradeInTokenExceptionMessage": { "type": "string" }, "com.amazonaws.sts#externalIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 1224 }, "smithy.api#pattern": "^[\\w+=,.@:\\/-]*$" } }, "com.amazonaws.sts#federatedIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 193 }, "smithy.api#pattern": "^[\\w+=,.@\\:-]*$" } }, "com.amazonaws.sts#idpCommunicationErrorMessage": { "type": "string" }, "com.amazonaws.sts#idpRejectedClaimMessage": { "type": "string" }, "com.amazonaws.sts#insufficientSessionLifetimeMessage": { "type": "string" }, "com.amazonaws.sts#invalidAuthorizationMessage": { "type": "string" }, "com.amazonaws.sts#invalidIdentityTokenMessage": { "type": "string" }, "com.amazonaws.sts#jwtAlgorithmType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 5 } } }, "com.amazonaws.sts#malformedPolicyDocumentMessage": { "type": "string" }, "com.amazonaws.sts#minimumSessionTokenSizeType": { "type": "integer", "traits": { "smithy.api#documentation": "

The minimum size, in bytes, of the session token that STS issues for the request. STS\n increases the session token to at least this size, regardless of its actual content. The\n value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is\n unchanged.

", "smithy.api#range": { "min": 0, "max": 4096 } } }, "com.amazonaws.sts#nonNegativeIntegerType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.sts#originIdentityIssuerType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.sts#originIdentitySubjectType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.sts#originIdentitySubjectTypeType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.sts#packedPolicyTooLargeMessage": { "type": "string" }, "com.amazonaws.sts#policyDescriptorListType": { "type": "list", "member": { "target": "com.amazonaws.sts#PolicyDescriptorType" } }, "com.amazonaws.sts#regionDisabledMessage": { "type": "string" }, "com.amazonaws.sts#roleDurationSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 900, "max": 43200 } } }, "com.amazonaws.sts#roleSessionNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#scopedCredentialDurationSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 129600 } } }, "com.amazonaws.sts#scopedPoliciesCountType": { "type": "integer", "traits": { "smithy.api#documentation": "The number of GetScopedCredentials scope-down policies present on the resulting session \u2014 the\n scoped credentials returned by this call. This is the caller's existing GetScopedCredentials\n scope-down count plus the one this request appends when it supplies a Policy. Only scope-down\n policies that originated from GetScopedCredentials are counted; scope-downs applied by other\n flows are excluded. A GetScopedCredentials request that supplies only a DurationSeconds (no\n Policy) adds no scope-down policy, so this value matches the caller's existing count.", "smithy.api#range": { "min": 0 } } }, "com.amazonaws.sts#scopedSessionDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 256 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "com.amazonaws.sts#scopedSessionIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 193 }, "smithy.api#pattern": "^[\\w+=,.@:-]*$" } }, "com.amazonaws.sts#serialNumberType": { "type": "string", "traits": { "smithy.api#length": { "min": 9, "max": 256 }, "smithy.api#pattern": "^[\\w+=/:,.@-]*$" } }, "com.amazonaws.sts#sessionPolicyDocumentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.sts#sessionTokenSizeType": { "type": "integer", "traits": { "smithy.api#documentation": "

The size, in bytes, of the session token returned in the Credentials for this\n response.

", "smithy.api#range": { "min": 0 } } }, "com.amazonaws.sts#sessionTokenUtilizationType": { "type": "integer", "traits": { "smithy.api#documentation": "

The percentage (0-100) of the maximum allowed session token size that the returned\n session token consumes.

", "smithy.api#range": { "min": 0 } } }, "com.amazonaws.sts#sourceIdentityType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 256 }, "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#tagKeyListType": { "type": "list", "member": { "target": "com.amazonaws.sts#tagKeyType" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.sts#tagKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" } }, "com.amazonaws.sts#tagListType": { "type": "list", "member": { "target": "com.amazonaws.sts#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.sts#tagValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" } }, "com.amazonaws.sts#tokenCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 6 }, "smithy.api#pattern": "^[\\d]*$" } }, "com.amazonaws.sts#tokenType": { "type": "string" }, "com.amazonaws.sts#tradeInTokenType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.sts#transactionContextIdentityProviderMapType": { "type": "map", "key": { "target": "com.amazonaws.sts#transactionContextKeyType" }, "value": { "target": "com.amazonaws.sts#transactionContextValueType" } }, "com.amazonaws.sts#transactionContextKeyType": { "type": "string" }, "com.amazonaws.sts#transactionContextValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.sts#unrestrictedSessionPolicyDocumentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.sts#urlType": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 2048 } } }, "com.amazonaws.sts#userIdType": { "type": "string" }, "com.amazonaws.sts#userNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 32 }, "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#webIdentitySubjectType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 255 } } }, "com.amazonaws.sts#webIdentityTokenAudienceListType": { "type": "list", "member": { "target": "com.amazonaws.sts#webIdentityTokenAudienceStringType" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.sts#webIdentityTokenAudienceStringType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.sts#webIdentityTokenDurationSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 3600 } } }, "com.amazonaws.sts#webIdentityTokenScopeType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\x21\\x23-\\x2B\\x2D-\\x5B\\x5D-\\x7E]+( [\\x21\\x23-\\x2B\\x2D-\\x5B\\x5D-\\x7E]+)*$" } }, "com.amazonaws.sts#webIdentityTokenSubjectModeType": { "type": "enum", "members": { "AWS_IDENTITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSIdentity" } }, "ORIGIN_IDENTITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OriginIdentity" } } } }, "com.amazonaws.sts#webIdentityTokenType": { "type": "string", "traits": { "smithy.api#sensitive": {} } } } }