'2011-06-15', 'endpointPrefix' => 'sts', 'serviceFullName' => 'AWS Security Token Service', 'serviceAbbreviation' => 'AWS STS', 'serviceType' => 'query', 'globalEndpoint' => 'sts.amazonaws.com', 'resultWrapped' => true, 'signatureVersion' => 'v4', 'namespace' => 'Sts', 'regions' => array( 'us-east-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'us-west-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'us-west-2' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'eu-west-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'ap-northeast-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'ap-southeast-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'ap-southeast-2' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), 'sa-east-1' => array( 'http' => false, 'https' => true, 'hostname' => 'sts.amazonaws.com', ), ), 'operations' => array( 'AssumeRole' => array( 'httpMethod' => 'POST', 'uri' => '/', 'class' => 'Aws\\Common\\Command\\QueryCommand', 'responseClass' => 'AssumeRoleResponse', 'responseType' => 'model', 'summary' => 'Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use AssumeRole for cross-account access or federation.', 'parameters' => array( 'Action' => array( 'static' => true, 'location' => 'aws.query', 'default' => 'AssumeRole', ), 'Version' => array( 'static' => true, 'location' => 'aws.query', 'default' => '2011-06-15', ), 'RoleArn' => array( 'required' => true, 'description' => 'The Amazon Resource Name (ARN) of the role that the caller is assuming.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 20, 'maxLength' => 2048, ), 'RoleSessionName' => array( 'required' => true, 'description' => 'An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 2, 'maxLength' => 32, ), 'Policy' => array( 'description' => 'A supplemental policy that is associated with the temporary security credentials from the AssumeRole call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 1, 'maxLength' => 2048, ), 'DurationSeconds' => array( 'description' => 'The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.', 'type' => 'numeric', 'location' => 'aws.query', 'minimum' => 900, 'maximum' => 3600, ), 'ExternalId' => array( 'description' => 'A unique identifier that is used by third parties to assume a role in their customers\' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer\'s external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 2, 'maxLength' => 96, ), ), 'errorResponses' => array( array( 'reason' => 'The request was rejected because the policy document was malformed. The error message describes the specific error.', 'class' => 'MalformedPolicyDocumentException', ), array( 'reason' => 'The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.', 'class' => 'PackedPolicyTooLargeException', ), ), ), 'AssumeRoleWithWebIdentity' => array( 'httpMethod' => 'POST', 'uri' => '/', 'class' => 'Aws\\Common\\Command\\QueryCommand', 'responseClass' => 'AssumeRoleWithWebIdentityResponse', 'responseType' => 'model', 'summary' => 'Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google. AssumeRoleWithWebIdentity is an API call that does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application or by deploying server-based proxy services that use long-term AWS credentials. For more information, see Creating a Mobile Application with Third-Party Sign-In in AWS Security Token Service.', 'parameters' => array( 'Action' => array( 'static' => true, 'location' => 'aws.query', 'default' => 'AssumeRoleWithWebIdentity', ), 'Version' => array( 'static' => true, 'location' => 'aws.query', 'default' => '2011-06-15', ), 'RoleArn' => array( 'required' => true, 'description' => 'The Amazon Resource Name (ARN) of the role that the caller is assuming.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 20, 'maxLength' => 2048, ), 'RoleSessionName' => array( 'required' => true, 'description' => 'An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 2, 'maxLength' => 32, ), 'WebIdentityToken' => array( 'required' => true, 'description' => 'The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 4, 'maxLength' => 2048, ), 'ProviderId' => array( 'description' => 'Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as accounts.google.com. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, www.amazon.com and graph.facebook.com are supported.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 4, 'maxLength' => 2048, ), 'Policy' => array( 'description' => 'A supplemental policy that is associated with the temporary security credentials from the AssumeRoleWithWebIdentity call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 1, 'maxLength' => 2048, ), 'DurationSeconds' => array( 'description' => 'The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.', 'type' => 'numeric', 'location' => 'aws.query', 'minimum' => 900, 'maximum' => 129600, ), ), 'errorResponses' => array( array( 'reason' => 'The request was rejected because the policy document was malformed. The error message describes the specific error.', 'class' => 'MalformedPolicyDocumentException', ), array( 'reason' => 'The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.', 'class' => 'PackedPolicyTooLargeException', ), array( 'reason' => 'The non-AWS identity provider (IDP) that was asked to verify the incoming identity token rejected the identity claim. This might be because the claim is invalid, has expired, or has been explicitly revoked by the user. The error message contains details about the response from the non-AWS identity provider.', 'class' => 'IDPRejectedClaimException', ), array( 'reason' => 'The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don\'t exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.', 'class' => 'IDPCommunicationErrorException', ), array( 'reason' => 'The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.', 'class' => 'InvalidIdentityTokenException', ), array( 'class' => 'ExpiredTokenException', ), ), ), 'GetFederationToken' => array( 'httpMethod' => 'POST', 'uri' => '/', 'class' => 'Aws\\Common\\Command\\QueryCommand', 'responseClass' => 'GetFederationTokenResponse', 'responseType' => 'model', 'summary' => 'Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that is getting temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the GetFederationToken action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application.', 'parameters' => array( 'Action' => array( 'static' => true, 'location' => 'aws.query', 'default' => 'GetFederationToken', ), 'Version' => array( 'static' => true, 'location' => 'aws.query', 'default' => '2011-06-15', ), 'Name' => array( 'required' => true, 'description' => 'The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 2, 'maxLength' => 32, ), 'Policy' => array( 'description' => 'A policy that specifies the permissions that are granted to the federated user. By default, federated users have no permissions; they do not inherit any from the IAM user. When you specify a policy, the federated user\'s permissions are intersection of the specified policy and the IAM user\'s policy. If you don\'t specify a policy, federated users can only access AWS resources that explicitly allow those federated users in a resource policy, such as in an Amazon S3 bucket policy.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 1, 'maxLength' => 2048, ), 'DurationSeconds' => array( 'description' => 'The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.', 'type' => 'numeric', 'location' => 'aws.query', 'minimum' => 900, 'maximum' => 129600, ), ), 'errorResponses' => array( array( 'reason' => 'The request was rejected because the policy document was malformed. The error message describes the specific error.', 'class' => 'MalformedPolicyDocumentException', ), array( 'reason' => 'The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.', 'class' => 'PackedPolicyTooLargeException', ), ), ), 'GetSessionToken' => array( 'httpMethod' => 'POST', 'uri' => '/', 'class' => 'Aws\\Common\\Command\\QueryCommand', 'responseClass' => 'GetSessionTokenResponse', 'responseType' => 'model', 'summary' => 'Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication.', 'parameters' => array( 'Action' => array( 'static' => true, 'location' => 'aws.query', 'default' => 'GetSessionToken', ), 'Version' => array( 'static' => true, 'location' => 'aws.query', 'default' => '2011-06-15', ), 'DurationSeconds' => array( 'description' => 'The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.', 'type' => 'numeric', 'location' => 'aws.query', 'minimum' => 900, 'maximum' => 129600, ), 'SerialNumber' => array( 'description' => 'The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user\'s security credentials.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 9, 'maxLength' => 256, ), 'TokenCode' => array( 'description' => 'The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.', 'type' => 'string', 'location' => 'aws.query', 'minLength' => 6, 'maxLength' => 6, ), ), ), ), 'models' => array( 'AssumeRoleResponse' => array( 'type' => 'object', 'additionalProperties' => true, 'properties' => array( 'Credentials' => array( 'description' => 'The temporary security credentials, which include an access key ID, a secret access key, and a security token.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AccessKeyId' => array( 'description' => 'AccessKeyId ID that identifies the temporary credentials.', 'type' => 'string', ), 'SecretAccessKey' => array( 'description' => 'The secret access key to sign requests.', 'type' => 'string', ), 'SessionToken' => array( 'description' => 'The security token that users must pass to the service API to use the temporary credentials.', 'type' => 'string', ), 'Expiration' => array( 'description' => 'The date on which these credentials expire.', 'type' => 'string', ), ), ), 'AssumedRoleUser' => array( 'description' => 'The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AssumedRoleId' => array( 'description' => 'A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID was generated by AWS when the role was created.', 'type' => 'string', ), 'Arn' => array( 'description' => '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 policies, see Identifiers for IAM Entities in Using IAM.', 'type' => 'string', ), ), ), 'PackedPolicySize' => array( 'description' => 'A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.', 'type' => 'numeric', 'location' => 'xml', ), ), ), 'AssumeRoleWithWebIdentityResponse' => array( 'type' => 'object', 'additionalProperties' => true, 'properties' => array( 'Credentials' => array( 'description' => 'The temporary security credentials, which include an access key ID, a secret access key, and a security token.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AccessKeyId' => array( 'description' => 'AccessKeyId ID that identifies the temporary credentials.', 'type' => 'string', ), 'SecretAccessKey' => array( 'description' => 'The secret access key to sign requests.', 'type' => 'string', ), 'SessionToken' => array( 'description' => 'The security token that users must pass to the service API to use the temporary credentials.', 'type' => 'string', ), 'Expiration' => array( 'description' => 'The date on which these credentials expire.', 'type' => 'string', ), ), ), 'SubjectFromWebIdentityToken' => array( 'description' => 'The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). If an OpenID Connect ID token was submitted in the WebIdentityToken, this value is returned by the identity provider as the token\'s sub (Subject) claim.', 'type' => 'string', 'location' => 'xml', ), 'AssumedRoleUser' => array( 'description' => 'The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AssumedRoleId' => array( 'description' => 'A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID was generated by AWS when the role was created.', 'type' => 'string', ), 'Arn' => array( 'description' => '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 policies, see Identifiers for IAM Entities in Using IAM.', 'type' => 'string', ), ), ), 'PackedPolicySize' => array( 'description' => 'A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.', 'type' => 'numeric', 'location' => 'xml', ), ), ), 'GetFederationTokenResponse' => array( 'type' => 'object', 'additionalProperties' => true, 'properties' => array( 'Credentials' => array( 'description' => 'Credentials for the service API authentication.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AccessKeyId' => array( 'description' => 'AccessKeyId ID that identifies the temporary credentials.', 'type' => 'string', ), 'SecretAccessKey' => array( 'description' => 'The secret access key to sign requests.', 'type' => 'string', ), 'SessionToken' => array( 'description' => 'The security token that users must pass to the service API to use the temporary credentials.', 'type' => 'string', ), 'Expiration' => array( 'description' => 'The date on which these credentials expire.', 'type' => 'string', ), ), ), 'FederatedUser' => array( 'description' => 'Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user\'s ARN in your resource policies like in an Amazon S3 bucket policy.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'FederatedUserId' => array( 'description' => 'The string identifying the federated user associated with the credentials, similar to the UserId of an IAM user.', 'type' => 'string', ), 'Arn' => array( 'description' => 'The ARN specifying the federated user associated with the credentials. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.', 'type' => 'string', ), ), ), 'PackedPolicySize' => array( 'description' => 'A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.', 'type' => 'numeric', 'location' => 'xml', ), ), ), 'GetSessionTokenResponse' => array( 'type' => 'object', 'additionalProperties' => true, 'properties' => array( 'Credentials' => array( 'description' => 'The session credentials for API authentication.', 'type' => 'object', 'location' => 'xml', 'properties' => array( 'AccessKeyId' => array( 'description' => 'AccessKeyId ID that identifies the temporary credentials.', 'type' => 'string', ), 'SecretAccessKey' => array( 'description' => 'The secret access key to sign requests.', 'type' => 'string', ), 'SessionToken' => array( 'description' => 'The security token that users must pass to the service API to use the temporary credentials.', 'type' => 'string', ), 'Expiration' => array( 'description' => 'The date on which these credentials expire.', 'type' => 'string', ), ), ), ), ), ), );