aws-sdk-core 2.0.48 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/apis/autoscaling/2011-01-01/api-2.json +636 -33
- data/apis/cloudhsm/2014-05-30/api-2.json +3 -6
- data/apis/ec2/2014-10-01/api-2.json +10267 -0
- data/apis/ec2/2014-10-01/paginators-1.json +125 -0
- data/apis/ec2/2014-10-01/resources-1.json +2289 -0
- data/apis/ec2/2014-10-01/waiters-2.json +453 -0
- data/apis/ec2/2015-03-01/api-2.json +11245 -0
- data/apis/ec2/2015-03-01/paginators-1.json +125 -0
- data/apis/ec2/2015-03-01/resources-1.json +2479 -0
- data/apis/ec2/2015-03-01/waiters-2.json +458 -0
- data/apis/ec2/2015-04-15/api-2.json +182 -2
- data/apis/ecs/2014-11-13/api-2.json +316 -7
- data/apis/ecs/2014-11-13/paginators-1.json +40 -0
- data/apis/ecs/2014-11-13/waiters-2.json +93 -0
- data/apis/redshift/2012-12-01/waiters-2.json +19 -0
- data/apis/s3/2006-03-01/api-2.json +1 -2
- data/apis/sqs/2012-11-05/api-2.json +5 -6
- data/ca-bundle.crt +3554 -0
- data/lib/aws-sdk-core.rb +127 -44
- data/lib/aws-sdk-core/api/builder.rb +95 -0
- data/lib/aws-sdk-core/api/customizations.rb +152 -0
- data/lib/aws-sdk-core/api/docs/builder.rb +220 -0
- data/lib/aws-sdk-core/api/docs/client_type_documenter.rb +109 -0
- data/lib/aws-sdk-core/api/docs/docstring_provider.rb +66 -0
- data/lib/aws-sdk-core/api/docs/operation_documenter.rb +107 -0
- data/lib/aws-sdk-core/api/docs/param_formatter.rb +163 -0
- data/lib/aws-sdk-core/api/docs/request_syntax_example.rb +22 -0
- data/lib/aws-sdk-core/api/docs/response_structure_example.rb +91 -0
- data/lib/aws-sdk-core/api/docs/utils.rb +133 -0
- data/lib/aws-sdk-core/api/shape_map.rb +140 -0
- data/lib/aws-sdk-core/assume_role_credentials.rb +9 -6
- data/lib/aws-sdk-core/client.rb +9 -6
- data/lib/aws-sdk-core/client_stubs.rb +127 -133
- data/lib/aws-sdk-core/client_waiters.rb +1 -1
- data/lib/aws-sdk-core/credential_provider.rb +44 -0
- data/lib/aws-sdk-core/credential_provider_chain.rb +3 -2
- data/lib/aws-sdk-core/credentials.rb +5 -0
- data/lib/aws-sdk-core/deprecations.rb +69 -0
- data/lib/aws-sdk-core/dynamodb.rb +12 -0
- data/lib/aws-sdk-core/eager_loader.rb +31 -0
- data/lib/aws-sdk-core/ecs.rb +2 -0
- data/lib/aws-sdk-core/empty_structure.rb +1 -82
- data/lib/aws-sdk-core/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-core/instance_profile_credentials.rb +9 -10
- data/lib/aws-sdk-core/json.rb +56 -0
- data/lib/aws-sdk-core/json/builder.rb +33 -34
- data/lib/aws-sdk-core/json/error_handler.rb +2 -2
- data/lib/aws-sdk-core/json/handler.rb +67 -0
- data/lib/aws-sdk-core/json/json_engine.rb +15 -0
- data/lib/aws-sdk-core/json/oj_engine.rb +15 -0
- data/lib/aws-sdk-core/json/parser.rb +30 -38
- data/lib/aws-sdk-core/pageable_response.rb +9 -12
- data/lib/aws-sdk-core/pager.rb +69 -0
- data/lib/aws-sdk-core/param_converter.rb +203 -0
- data/lib/aws-sdk-core/param_validator.rb +148 -0
- data/lib/aws-sdk-core/plugins/dynamodb_simple_attributes.rb +21 -18
- data/lib/aws-sdk-core/plugins/glacier_account_id.rb +9 -1
- data/lib/aws-sdk-core/plugins/glacier_checksums.rb +2 -3
- data/lib/aws-sdk-core/plugins/param_converter.rb +27 -0
- data/lib/aws-sdk-core/plugins/param_validator.rb +28 -0
- data/lib/aws-sdk-core/plugins/protocols/json_rpc.rb +3 -7
- data/lib/aws-sdk-core/plugins/protocols/rest_json.rb +1 -2
- data/lib/aws-sdk-core/plugins/protocols/rest_xml.rb +1 -1
- data/lib/aws-sdk-core/plugins/regional_endpoint.rb +1 -1
- data/lib/aws-sdk-core/plugins/request_signer.rb +5 -5
- data/lib/aws-sdk-core/plugins/response_paging.rb +20 -11
- data/lib/aws-sdk-core/plugins/s3_get_bucket_location_fix.rb +1 -1
- data/lib/aws-sdk-core/plugins/s3_request_signer.rb +1 -2
- data/lib/aws-sdk-core/plugins/stub_responses.rb +25 -27
- data/lib/aws-sdk-core/query/ec2_param_builder.rb +29 -34
- data/lib/aws-sdk-core/query/handler.rb +32 -18
- data/lib/aws-sdk-core/query/param_builder.rb +45 -53
- data/lib/aws-sdk-core/refreshing_credentials.rb +3 -15
- data/lib/aws-sdk-core/rest/handler.rb +22 -0
- data/lib/aws-sdk-core/rest/request/body.rb +58 -0
- data/lib/aws-sdk-core/rest/request/builder.rb +50 -0
- data/lib/aws-sdk-core/rest/request/endpoint.rb +70 -0
- data/lib/aws-sdk-core/rest/request/headers.rb +48 -0
- data/lib/aws-sdk-core/rest/response/body.rb +43 -0
- data/lib/aws-sdk-core/rest/response/headers.rb +60 -0
- data/lib/aws-sdk-core/rest/response/parser.rb +47 -0
- data/lib/aws-sdk-core/rest/response/status_code.rb +24 -0
- data/lib/aws-sdk-core/shared_credentials.rb +11 -6
- data/lib/aws-sdk-core/signers/base.rb +1 -1
- data/lib/aws-sdk-core/signers/s3.rb +2 -3
- data/lib/aws-sdk-core/signers/v2.rb +7 -4
- data/lib/aws-sdk-core/signers/v4.rb +11 -22
- data/lib/aws-sdk-core/structure.rb +26 -145
- data/lib/aws-sdk-core/stubbing/data_applicator.rb +46 -0
- data/lib/aws-sdk-core/stubbing/empty_stub.rb +53 -0
- data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +49 -0
- data/lib/aws-sdk-core/stubbing/protocols/json.rb +40 -0
- data/lib/aws-sdk-core/stubbing/protocols/query.rb +40 -0
- data/lib/aws-sdk-core/stubbing/protocols/rest.rb +67 -0
- data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +25 -0
- data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +38 -0
- data/lib/aws-sdk-core/stubbing/stub_data.rb +34 -0
- data/lib/aws-sdk-core/version.rb +1 -1
- data/lib/aws-sdk-core/xml/builder.rb +58 -52
- data/lib/aws-sdk-core/xml/default_map.rb +10 -0
- data/lib/aws-sdk-core/xml/doc_builder.rb +86 -0
- data/lib/aws-sdk-core/xml/error_handler.rb +7 -2
- data/lib/aws-sdk-core/xml/parser.rb +4 -4
- data/lib/aws-sdk-core/xml/parser/frame.rb +75 -70
- data/lib/aws-sdk-core/xml/parser/stack.rb +4 -4
- data/lib/seahorse.rb +0 -11
- data/lib/seahorse/client/base.rb +3 -12
- data/lib/seahorse/client/http/request.rb +9 -5
- data/lib/seahorse/client/plugins/endpoint.rb +5 -56
- data/lib/seahorse/client/plugins/restful_bindings.rb +38 -31
- data/lib/seahorse/client/request_context.rb +2 -2
- data/lib/seahorse/client/response.rb +6 -5
- data/lib/seahorse/model/api.rb +18 -61
- data/lib/seahorse/model/operation.rb +24 -54
- data/lib/seahorse/model/shapes.rb +120 -364
- data/lib/seahorse/util.rb +2 -6
- metadata +56 -109
- data/apis/autoscaling/2011-01-01/docs-2.json +0 -1246
- data/apis/cloudformation/2010-05-15/docs-2.json +0 -725
- data/apis/cloudfront/2014-11-06/docs-2.json +0 -1125
- data/apis/cloudhsm/2014-05-30/docs-2.json +0 -472
- data/apis/cloudsearch/2013-01-01/docs-2.json +0 -865
- data/apis/cloudsearchdomain/2013-01-01/docs-2.json +0 -311
- data/apis/cloudtrail/2013-11-01/docs-2.json +0 -328
- data/apis/codedeploy/2014-10-06/docs-2.json +0 -1261
- data/apis/cognito-identity/2014-06-30/docs-2.json +0 -506
- data/apis/cognito-sync/2014-06-30/docs-2.json +0 -582
- data/apis/config/2014-10-17/docs-2.json +0 -513
- data/apis/config/2014-11-12/docs-2.json +0 -514
- data/apis/datapipeline/2012-10-29/docs-2.json +0 -607
- data/apis/directconnect/2012-10-25/docs-2.json +0 -494
- data/apis/ds/2015-04-16/docs-2.json +0 -753
- data/apis/dynamodb/2011-12-05/api-2.json +0 -949
- data/apis/dynamodb/2011-12-05/docs-2.json +0 -606
- data/apis/dynamodb/2011-12-05/paginators-1.json +0 -26
- data/apis/dynamodb/2011-12-05/waiters-2.json +0 -35
- data/apis/dynamodb/2012-08-10/docs-2.json +0 -977
- data/apis/ec2/2015-04-15/docs-2.json +0 -5368
- data/apis/ecs/2014-11-13/docs-2.json +0 -791
- data/apis/elasticache/2015-02-02/docs-2.json +0 -1390
- data/apis/elasticbeanstalk/2010-12-01/docs-2.json +0 -1114
- data/apis/elasticfilesystem/2015-02-01/docs-2.json +0 -414
- data/apis/elasticloadbalancing/2012-06-01/docs-2.json +0 -1078
- data/apis/elasticmapreduce/2009-03-31/docs-2.json +0 -969
- data/apis/elastictranscoder/2012-09-25/docs-2.json +0 -1152
- data/apis/email/2010-12-01/docs-2.json +0 -441
- data/apis/glacier/2012-06-01/docs-2.json +0 -575
- data/apis/iam/2010-05-08/docs-2.json +0 -2138
- data/apis/importexport/2010-06-01/docs-2.json +0 -432
- data/apis/kinesis/2013-12-02/docs-2.json +0 -424
- data/apis/kms/2014-11-01/docs-2.json +0 -628
- data/apis/lambda/2014-11-11/docs-2.json +0 -303
- data/apis/lambda/2015-03-31/docs-2.json +0 -490
- data/apis/logs/2014-03-28/docs-2.json +0 -599
- data/apis/machinelearning/2014-12-12/docs-2.json +0 -1034
- data/apis/monitoring/2010-08-01/docs-2.json +0 -514
- data/apis/opsworks/2013-02-18/docs-2.json +0 -1592
- data/apis/rds/2014-10-31/docs-2.json +0 -2074
- data/apis/redshift/2012-12-01/docs-2.json +0 -1890
- data/apis/route53/2013-04-01/docs-2.json +0 -1159
- data/apis/route53domains/2014-05-15/docs-2.json +0 -620
- data/apis/s3/2006-03-01/docs-2.json +0 -2213
- data/apis/sdb/2009-04-15/docs-2.json +0 -339
- data/apis/sns/2010-03-31/docs-2.json +0 -564
- data/apis/sqs/2012-11-05/docs-2.json +0 -503
- data/apis/ssm/2014-11-06/docs-2.json +0 -440
- data/apis/storagegateway/2013-06-30/docs-2.json +0 -1331
- data/apis/sts/2011-06-15/docs-2.json +0 -351
- data/apis/support/2013-04-15/docs-2.json +0 -680
- data/apis/swf/2012-01-25/docs-2.json +0 -1569
- data/apis/workspaces/2015-04-08/docs-2.json +0 -457
- data/lib/aws-sdk-core/api/customizer.rb +0 -75
- data/lib/aws-sdk-core/api/docstrings.rb +0 -38
- data/lib/aws-sdk-core/api/documenter.rb +0 -241
- data/lib/aws-sdk-core/api/operation_documenter.rb +0 -173
- data/lib/aws-sdk-core/api/operation_example.rb +0 -133
- data/lib/aws-sdk-core/api/service_customizations.rb +0 -140
- data/lib/aws-sdk-core/client_paging.rb +0 -31
- data/lib/aws-sdk-core/json/rest_handler.rb +0 -20
- data/lib/aws-sdk-core/json/rpc_body_handler.rb +0 -38
- data/lib/aws-sdk-core/json/rpc_headers_handler.rb +0 -34
- data/lib/aws-sdk-core/json/simple_body_handler.rb +0 -34
- data/lib/aws-sdk-core/paging/null_pager.rb +0 -20
- data/lib/aws-sdk-core/paging/null_provider.rb +0 -13
- data/lib/aws-sdk-core/paging/pager.rb +0 -70
- data/lib/aws-sdk-core/paging/provider.rb +0 -22
- data/lib/aws-sdk-core/rest_body_handler.rb +0 -111
- data/lib/aws-sdk-core/signers/handler.rb +0 -18
- data/lib/aws-sdk-core/xml/rest_handler.rb +0 -20
- data/lib/seahorse/client/param_converter.rb +0 -207
- data/lib/seahorse/client/param_validator.rb +0 -139
- data/lib/seahorse/client/plugins/json_simple.rb +0 -33
- data/lib/seahorse/client/plugins/param_conversion.rb +0 -29
- data/lib/seahorse/client/plugins/param_validation.rb +0 -30
- data/lib/seahorse/client/xml/builder.rb +0 -91
- data/lib/seahorse/model/shape_map.rb +0 -47
@@ -1,351 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"version": "2.0",
|
3
|
-
"operations": {
|
4
|
-
"AssumeRole": "<p>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 <code>AssumeRole</code> for cross-account access or federation. </p> <p><b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call <code>AssumeRole</code>. </p> <p>For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Roles</a> in <i>Using IAM</i>. </p> <p>For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/STSUseCases.html\">Scenarios for Granting Temporary Access</a> in <i>Using Temporary Security Credentials</i>. </p> <p>The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour. </p> <p>Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRole</a> in <i>Using Temporary Security Credentials</i>.</p> <p>To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call <code>sts:AssumeRole</code>. </p> <p> <b>Using MFA with AssumeRole</b> </p> <p>You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.</p> <p> <code>\"Condition\": {\"Null\": {\"aws:MultiFactorAuthAge\": false}}</code> </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html\">Configuring MFA-Protected API Access</a> in the <i>Using IAM</i> guide. </p> <p>To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </p> <member name=\"RoleArn\" target=\"arnType\"></member> <member name=\"RoleSessionName\" target=\"userNameType\"></member> <member name=\"Policy\" target=\"sessionPolicyDocumentType\"></member> <member name=\"DurationSeconds\" target=\"roleDurationSecondsType\"></member> <member name=\"ExternalId\" target=\"externalIdType\"></member>",
|
5
|
-
"AssumeRoleWithSAML": "<p>Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. </p> <p>The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithSAML</code>, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter.</p> <note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note> <p>Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRoleWithSAML</a> in <i>Using Temporary Security Credentials</i>.</p> <p>Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </p> <p>Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </p> <p>For more information, see the following resources:</p> <ul> <li> <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating Temporary Security Credentials for SAML Federation</a> in <i>Using Temporary Security Credentials</i>. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/idp-managing-identityproviders.html\">SAML Providers</a> in <i>Using IAM</i>. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html\">Configuring a Relying Party and Claims</a> in <i>Using IAM</i>. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml.html\">Creating a Role for SAML-Based Federation</a> in <i>Using IAM</i>. </li> </ul> <member name=\"RoleArn\" target=\"arnType\"></member> <member name=\"SAMLAssertion\" target=\"SAMLAssertionType\"></member> <member name=\"Policy\" target=\"sessionPolicyDocumentType\"></member> <member name=\"DurationSeconds\" target=\"roleDurationSecondsType\"></member>",
|
6
|
-
"AssumeRoleWithWebIdentity": "<p>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 Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. </p> <note> <p>For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href=\"http://aws.amazon.com/sdkforios/\">AWS SDK for iOS</a> and the <a href=\"http://aws.amazon.com/sdkforandroid/\">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.</p> <p>To learn more about Amazon Cognito, see <a href=\"http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840\">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href=\"http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664\">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>.</p> </note> <p>Calling <code>AssumeRoleWithWebIdentity</code> 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, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. </p> <p>The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour. </p> <p>Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRoleWithWebIdentity</a> in <i>Using Temporary Security Credentials</i>.</p> <p>Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </p> <p>For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p> <ul> <li> <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/STSUseCases.html#MobileApplication-KnownProvider\"> Creating a Mobile Application with Third-Party Sign-In</a> and <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingWIF.html\"> Creating Temporary Security Credentials for Mobile Apps Using Third-Party Identity Providers</a> in <i>Using Temporary Security Credentials</i>. </li> <li> <a href=\"https://web-identity-federation-playground.s3.amazonaws.com/index.html\"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </li> <li> <a href=\"http://aws.amazon.com/sdkforios/\">AWS SDK for iOS</a> and <a href=\"http://aws.amazon.com/sdkforandroid/\">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </li> <li> <a href=\"http://aws.amazon.com/articles/4617974389850313\">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </li> </ul>",
|
7
|
-
"DecodeAuthorizationMessage": "<p>Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. </p> <p>For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </p> <note> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </note> <p>The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </p> <p>The decoded message includes the following type of information: </p> <ul> <li>Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccessPolicyLanguage_EvaluationLogic.html#policy-eval-denyallow\">Determining Whether a Request is Allowed or Denied</a> in <i>Using IAM</i>. </li> <li>The principal who made the request.</li> <li>The requested action.</li> <li>The requested resource.</li> <li>The values of condition keys in the context of the user's request.</li> </ul>",
|
8
|
-
"GetFederationToken": "<p>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 gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> 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.</p> <note> <p> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href=\"http://aws.amazon.com/cognito/\">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingWIF.html\">Creating Temporary Security Credentials for Mobile Apps Using Identity Providers</a> in <i>Using Temporary Security Credentials</i>.</p> </note> <p>The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html\">IAM Best Practices</a> in <i>Using IAM</i>. </p> <p>The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour)</p> <p> <b>Permissions</b> </p> <p>The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </p> <ul> <li>The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>.</li> <li>The policy that is passed as a parameter in the call.</li> </ul> <p>The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i><b>and</b></i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy.</p> <p>A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </p> <p>If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </p> <p>For more information about how permissions work, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-get-federation-token.html\">Permissions for GetFederationToken</a> in <i>Using Temporary Security Credentials</i>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingFedTokens.html\">Creating Temporary Credentials to Enable Access for Federated Users</a> in <i>Using Temporary Security Credentials</i>. </p>",
|
9
|
-
"GetSessionToken": "<p>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 <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> 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. </p> <p>The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </p> <note> <p>We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html#create-iam-users\">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </p> </note> <p>The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </p> <p>For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSessionTokens.html\" target=\"_blank\">Creating Temporary Credentials to Enable Access for IAM Users</a> in <i>Using Temporary Security Credentials</i>. </p>"
|
10
|
-
},
|
11
|
-
"service": "<fullname>AWS Security Token Service</fullname> <p>The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/Welcome.html\" target=\"_blank\">Using Temporary Security Credentials</a>. </p> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services page</a>. </note> <p>For information about setting up signatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/UsingTokens.html\">Using Temporary Security Credentials to Access AWS</a> in <i>Using Temporary Security Credentials</i>. </p> <p>If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://aws.amazon.com/documentation/\" target=\"_blank\">http://aws.amazon.com/documentation/</a>. </p> <p> <b>Endpoints</b> </p> <p>The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available, but must first be activated in the AWS Management Console before you can use a different region's endpoint. For more information about activating a region for STS see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/sts-enableregions.html\">Activating STS in a New Region</a> in the <i>Using Temporary Security Credentials</i> guide. </p> <p>For information about STS endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region\">Regions and Endpoints</a> in the <i>AWS General Reference</i>.</p> <p> <b>Recording API requests</b> </p> <p>STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html\">AWS CloudTrail User Guide</a>.</p>",
|
12
|
-
"shapes": {
|
13
|
-
"AssumeRoleRequest": {
|
14
|
-
"base": null,
|
15
|
-
"refs": {
|
16
|
-
}
|
17
|
-
},
|
18
|
-
"AssumeRoleResponse": {
|
19
|
-
"base": "<p>Contains the response to a successful <a>AssumeRole</a> request, including temporary AWS credentials that can be used to make AWS requests. </p>",
|
20
|
-
"refs": {
|
21
|
-
}
|
22
|
-
},
|
23
|
-
"AssumeRoleWithSAMLRequest": {
|
24
|
-
"base": null,
|
25
|
-
"refs": {
|
26
|
-
}
|
27
|
-
},
|
28
|
-
"AssumeRoleWithSAMLResponse": {
|
29
|
-
"base": "<p>Contains the response to a successful <a>AssumeRoleWithSAML</a> request, including temporary AWS credentials that can be used to make AWS requests. </p>",
|
30
|
-
"refs": {
|
31
|
-
}
|
32
|
-
},
|
33
|
-
"AssumeRoleWithWebIdentityRequest": {
|
34
|
-
"base": null,
|
35
|
-
"refs": {
|
36
|
-
}
|
37
|
-
},
|
38
|
-
"AssumeRoleWithWebIdentityResponse": {
|
39
|
-
"base": "<p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a> request, including temporary AWS credentials that can be used to make AWS requests. </p>",
|
40
|
-
"refs": {
|
41
|
-
}
|
42
|
-
},
|
43
|
-
"AssumedRoleUser": {
|
44
|
-
"base": "<p>The identifiers for the temporary security credentials that the operation returns. </p>",
|
45
|
-
"refs": {
|
46
|
-
"AssumeRoleResponse$AssumedRoleUser": "<p>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 <code>RoleSessionName</code> that you specified when you called <code>AssumeRole</code>. </p>",
|
47
|
-
"AssumeRoleWithSAMLResponse$AssumedRoleUser": null,
|
48
|
-
"AssumeRoleWithWebIdentityResponse$AssumedRoleUser": "<p>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 <code>RoleSessionName</code> that you specified when you called <code>AssumeRole</code>. </p>"
|
49
|
-
}
|
50
|
-
},
|
51
|
-
"Audience": {
|
52
|
-
"base": null,
|
53
|
-
"refs": {
|
54
|
-
"AssumeRoleWithSAMLResponse$Audience": "<p> The value of the <code>Recipient</code> attribute of the <code>SubjectConfirmationData</code> element of the SAML assertion. </p>",
|
55
|
-
"AssumeRoleWithWebIdentityResponse$Audience": "<p> The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.</p>"
|
56
|
-
}
|
57
|
-
},
|
58
|
-
"Credentials": {
|
59
|
-
"base": "<p>AWS credentials for API authentication.</p>",
|
60
|
-
"refs": {
|
61
|
-
"AssumeRoleResponse$Credentials": "<p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p>",
|
62
|
-
"AssumeRoleWithSAMLResponse$Credentials": null,
|
63
|
-
"AssumeRoleWithWebIdentityResponse$Credentials": "<p>The temporary security credentials, which include an access key ID, a secret access key, and a security token.</p>",
|
64
|
-
"GetFederationTokenResponse$Credentials": "<p>Credentials for the service API authentication. </p>",
|
65
|
-
"GetSessionTokenResponse$Credentials": "<p>The session credentials for API authentication. </p>"
|
66
|
-
}
|
67
|
-
},
|
68
|
-
"DecodeAuthorizationMessageRequest": {
|
69
|
-
"base": null,
|
70
|
-
"refs": {
|
71
|
-
}
|
72
|
-
},
|
73
|
-
"DecodeAuthorizationMessageResponse": {
|
74
|
-
"base": "<p>A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request. </p>",
|
75
|
-
"refs": {
|
76
|
-
}
|
77
|
-
},
|
78
|
-
"ExpiredTokenException": {
|
79
|
-
"base": "<p>The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </p>",
|
80
|
-
"refs": {
|
81
|
-
}
|
82
|
-
},
|
83
|
-
"FederatedUser": {
|
84
|
-
"base": "<p>Identifiers for the federated user that is associated with the credentials.</p>",
|
85
|
-
"refs": {
|
86
|
-
"GetFederationTokenResponse$FederatedUser": "<p>Identifiers for the federated user associated with the credentials (such as <code>arn:aws:sts::123456789012:federated-user/Bob</code> or <code>123456789012:Bob</code>). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy. </p>"
|
87
|
-
}
|
88
|
-
},
|
89
|
-
"GetFederationTokenRequest": {
|
90
|
-
"base": null,
|
91
|
-
"refs": {
|
92
|
-
}
|
93
|
-
},
|
94
|
-
"GetFederationTokenResponse": {
|
95
|
-
"base": "<p>Contains the response to a successful <a>GetFederationToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </p>",
|
96
|
-
"refs": {
|
97
|
-
}
|
98
|
-
},
|
99
|
-
"GetSessionTokenRequest": {
|
100
|
-
"base": null,
|
101
|
-
"refs": {
|
102
|
-
}
|
103
|
-
},
|
104
|
-
"GetSessionTokenResponse": {
|
105
|
-
"base": "<p>Contains the response to a successful <a>GetSessionToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </p>",
|
106
|
-
"refs": {
|
107
|
-
}
|
108
|
-
},
|
109
|
-
"IDPCommunicationErrorException": {
|
110
|
-
"base": "<p>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. </p>",
|
111
|
-
"refs": {
|
112
|
-
}
|
113
|
-
},
|
114
|
-
"IDPRejectedClaimException": {
|
115
|
-
"base": "<p>The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.</p> <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </p>",
|
116
|
-
"refs": {
|
117
|
-
}
|
118
|
-
},
|
119
|
-
"InvalidAuthorizationMessageException": {
|
120
|
-
"base": "<p>The error returned if the message passed to <code>DecodeAuthorizationMessage</code> was invalid. This can happen if the token contains invalid characters, such as linebreaks. </p>",
|
121
|
-
"refs": {
|
122
|
-
}
|
123
|
-
},
|
124
|
-
"InvalidIdentityTokenException": {
|
125
|
-
"base": "<p>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. </p>",
|
126
|
-
"refs": {
|
127
|
-
}
|
128
|
-
},
|
129
|
-
"Issuer": {
|
130
|
-
"base": null,
|
131
|
-
"refs": {
|
132
|
-
"AssumeRoleWithSAMLResponse$Issuer": "<p>The value of the <code>Issuer</code> element of the SAML assertion.</p>",
|
133
|
-
"AssumeRoleWithWebIdentityResponse$Provider": "<p> The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the <code>iss</code> field. For OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code> parameter that was passed in the <code>AssumeRoleWithWebIdentity</code> request.</p>"
|
134
|
-
}
|
135
|
-
},
|
136
|
-
"MalformedPolicyDocumentException": {
|
137
|
-
"base": "<p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p>",
|
138
|
-
"refs": {
|
139
|
-
}
|
140
|
-
},
|
141
|
-
"NameQualifier": {
|
142
|
-
"base": null,
|
143
|
-
"refs": {
|
144
|
-
"AssumeRoleWithSAMLResponse$NameQualifier": "<p>A hash value based on the concatenation of the <code>Issuer</code> response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of <code>NameQualifier</code> and <code>Subject</code> can be used to uniquely identify a federated user. </p> <p>The following pseudocode shows how the hash value is calculated:</p> <p> <code>BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )</code> </p>"
|
145
|
-
}
|
146
|
-
},
|
147
|
-
"PackedPolicyTooLargeException": {
|
148
|
-
"base": "<p>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.</p>",
|
149
|
-
"refs": {
|
150
|
-
}
|
151
|
-
},
|
152
|
-
"SAMLAssertionType": {
|
153
|
-
"base": null,
|
154
|
-
"refs": {
|
155
|
-
"AssumeRoleWithSAMLRequest$SAMLAssertion": "<p>The base-64 encoded SAML authentication response provided by the IdP.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html\">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </p>"
|
156
|
-
}
|
157
|
-
},
|
158
|
-
"Subject": {
|
159
|
-
"base": null,
|
160
|
-
"refs": {
|
161
|
-
"AssumeRoleWithSAMLResponse$Subject": "<p>The value of the <code>NameID</code> element in the <code>Subject</code> element of the SAML assertion.</p>"
|
162
|
-
}
|
163
|
-
},
|
164
|
-
"SubjectType": {
|
165
|
-
"base": null,
|
166
|
-
"refs": {
|
167
|
-
"AssumeRoleWithSAMLResponse$SubjectType": "<p> The format of the name ID, as defined by the <code>Format</code> attribute in the <code>NameID</code> element of the SAML assertion. Typical examples of the format are <code>transient</code> or <code>persistent</code>. </p> <p> If the format includes the prefix <code>urn:oasis:names:tc:SAML:2.0:nameid-format</code>, that prefix is removed. For example, <code>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</code> is returned as <code>transient</code>. If the format includes any other prefix, the format is returned with no modifications.</p>"
|
168
|
-
}
|
169
|
-
},
|
170
|
-
"accessKeyIdType": {
|
171
|
-
"base": null,
|
172
|
-
"refs": {
|
173
|
-
"Credentials$AccessKeyId": "<p>The access key ID that identifies the temporary security credentials.</p>"
|
174
|
-
}
|
175
|
-
},
|
176
|
-
"accessKeySecretType": {
|
177
|
-
"base": null,
|
178
|
-
"refs": {
|
179
|
-
"Credentials$SecretAccessKey": "<p>The secret access key that can be used to sign requests.</p>"
|
180
|
-
}
|
181
|
-
},
|
182
|
-
"arnType": {
|
183
|
-
"base": null,
|
184
|
-
"refs": {
|
185
|
-
"AssumeRoleRequest$RoleArn": "<p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>",
|
186
|
-
"AssumeRoleWithSAMLRequest$RoleArn": "<p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>",
|
187
|
-
"AssumeRoleWithSAMLRequest$PrincipalArn": "<p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.</p>",
|
188
|
-
"AssumeRoleWithWebIdentityRequest$RoleArn": "<p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>",
|
189
|
-
"AssumedRoleUser$Arn": "<p>The ARN of the temporary security credentials that are returned from the <a>AssumeRole</a> action. For more information about ARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\" target=\"_blank\"> Identifiers for IAM Entities </a> in <i>Using IAM</i>. </p>",
|
190
|
-
"FederatedUser$Arn": "<p>The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using IAM</i>. </p>"
|
191
|
-
}
|
192
|
-
},
|
193
|
-
"assumedRoleIdType": {
|
194
|
-
"base": null,
|
195
|
-
"refs": {
|
196
|
-
"AssumedRoleUser$AssumedRoleId": "<p>A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.</p>"
|
197
|
-
}
|
198
|
-
},
|
199
|
-
"clientTokenType": {
|
200
|
-
"base": null,
|
201
|
-
"refs": {
|
202
|
-
"AssumeRoleWithWebIdentityRequest$WebIdentityToken": "<p>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 <code>AssumeRoleWithWebIdentity</code> call. </p>"
|
203
|
-
}
|
204
|
-
},
|
205
|
-
"dateType": {
|
206
|
-
"base": null,
|
207
|
-
"refs": {
|
208
|
-
"Credentials$Expiration": "<p>The date on which the current credentials expire.</p>"
|
209
|
-
}
|
210
|
-
},
|
211
|
-
"decodedMessageType": {
|
212
|
-
"base": null,
|
213
|
-
"refs": {
|
214
|
-
"DecodeAuthorizationMessageResponse$DecodedMessage": "<p>An XML document that contains the decoded message. For more information, see <code>DecodeAuthorizationMessage</code>. </p>"
|
215
|
-
}
|
216
|
-
},
|
217
|
-
"durationSecondsType": {
|
218
|
-
"base": null,
|
219
|
-
"refs": {
|
220
|
-
"AssumeRoleWithSAMLRequest$DurationSeconds": "<p>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. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter. </p> <note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note>",
|
221
|
-
"AssumeRoleWithWebIdentityRequest$DurationSeconds": "<p>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. </p>",
|
222
|
-
"GetFederationTokenRequest$DurationSeconds": "<p>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 obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour. </p>",
|
223
|
-
"GetSessionTokenRequest$DurationSeconds": "<p>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. </p>"
|
224
|
-
}
|
225
|
-
},
|
226
|
-
"encodedMessageType": {
|
227
|
-
"base": null,
|
228
|
-
"refs": {
|
229
|
-
"DecodeAuthorizationMessageRequest$EncodedMessage": "<p>The encoded message that was returned with the response.</p>"
|
230
|
-
}
|
231
|
-
},
|
232
|
-
"expiredIdentityTokenMessage": {
|
233
|
-
"base": null,
|
234
|
-
"refs": {
|
235
|
-
"ExpiredTokenException$message": null
|
236
|
-
}
|
237
|
-
},
|
238
|
-
"externalIdType": {
|
239
|
-
"base": null,
|
240
|
-
"refs": {
|
241
|
-
"AssumeRoleRequest$ExternalId": "<p>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 <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/sts-delegating-externalid.html\" target=\"_blank\">About the External ID</a> in <i>Using Temporary Security Credentials</i>.</p>"
|
242
|
-
}
|
243
|
-
},
|
244
|
-
"federatedIdType": {
|
245
|
-
"base": null,
|
246
|
-
"refs": {
|
247
|
-
"FederatedUser$FederatedUserId": "<p>The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.</p>"
|
248
|
-
}
|
249
|
-
},
|
250
|
-
"idpCommunicationErrorMessage": {
|
251
|
-
"base": null,
|
252
|
-
"refs": {
|
253
|
-
"IDPCommunicationErrorException$message": null
|
254
|
-
}
|
255
|
-
},
|
256
|
-
"idpRejectedClaimMessage": {
|
257
|
-
"base": null,
|
258
|
-
"refs": {
|
259
|
-
"IDPRejectedClaimException$message": null
|
260
|
-
}
|
261
|
-
},
|
262
|
-
"invalidAuthorizationMessage": {
|
263
|
-
"base": null,
|
264
|
-
"refs": {
|
265
|
-
"InvalidAuthorizationMessageException$message": null
|
266
|
-
}
|
267
|
-
},
|
268
|
-
"invalidIdentityTokenMessage": {
|
269
|
-
"base": null,
|
270
|
-
"refs": {
|
271
|
-
"InvalidIdentityTokenException$message": null
|
272
|
-
}
|
273
|
-
},
|
274
|
-
"malformedPolicyDocumentMessage": {
|
275
|
-
"base": null,
|
276
|
-
"refs": {
|
277
|
-
"MalformedPolicyDocumentException$message": null
|
278
|
-
}
|
279
|
-
},
|
280
|
-
"nonNegativeIntegerType": {
|
281
|
-
"base": null,
|
282
|
-
"refs": {
|
283
|
-
"AssumeRoleResponse$PackedPolicySize": "<p>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. </p>",
|
284
|
-
"AssumeRoleWithSAMLResponse$PackedPolicySize": "<p>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. </p>",
|
285
|
-
"AssumeRoleWithWebIdentityResponse$PackedPolicySize": "<p>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. </p>",
|
286
|
-
"GetFederationTokenResponse$PackedPolicySize": "<p>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. </p>"
|
287
|
-
}
|
288
|
-
},
|
289
|
-
"packedPolicyTooLargeMessage": {
|
290
|
-
"base": null,
|
291
|
-
"refs": {
|
292
|
-
"PackedPolicyTooLargeException$message": null
|
293
|
-
}
|
294
|
-
},
|
295
|
-
"roleDurationSecondsType": {
|
296
|
-
"base": null,
|
297
|
-
"refs": {
|
298
|
-
"AssumeRoleRequest$DurationSeconds": "<p>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. </p>"
|
299
|
-
}
|
300
|
-
},
|
301
|
-
"serialNumberType": {
|
302
|
-
"base": null,
|
303
|
-
"refs": {
|
304
|
-
"AssumeRoleRequest$SerialNumber": "<p>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>).</p>",
|
305
|
-
"GetSessionTokenRequest$SerialNumber": "<p>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> 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 <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. </p>"
|
306
|
-
}
|
307
|
-
},
|
308
|
-
"sessionPolicyDocumentType": {
|
309
|
-
"base": null,
|
310
|
-
"refs": {
|
311
|
-
"AssumeRoleRequest$Policy": "<p>An IAM policy in JSON format.</p> <p>The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRole</a> in <i>Using Temporary Security Credentials</i>. </p>",
|
312
|
-
"AssumeRoleWithSAMLRequest$Policy": "<p>An IAM policy in JSON format.</p> <p>The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRoleWithSAML</a> in <i>Using Temporary Security Credentials</i>. </p> <note>The policy must be 2048 bytes or shorter, and its packed size must be less than 450 bytes.</note>",
|
313
|
-
"AssumeRoleWithWebIdentityRequest$Policy": "<p>An IAM policy in JSON format.</p> <p>The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html\">Permissions for AssumeRoleWithWebIdentity</a> in <i>Using Temporary Security Credentials</i>. </p>",
|
314
|
-
"GetFederationTokenRequest$Policy": "<p>An IAM policy in JSON format that is passed with the <code>GetFederationToken</code> call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.</p> <p>If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </p> <p>For more information about how permissions work, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-get-federation-token.html\">Permissions for GetFederationToken</a> in <i>Using Temporary Security Credentials</i>.</p>"
|
315
|
-
}
|
316
|
-
},
|
317
|
-
"tokenCodeType": {
|
318
|
-
"base": null,
|
319
|
-
"refs": {
|
320
|
-
"AssumeRoleRequest$TokenCode": "<p>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an \"access denied\" error.</p>",
|
321
|
-
"GetSessionTokenRequest$TokenCode": "<p>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.</p>"
|
322
|
-
}
|
323
|
-
},
|
324
|
-
"tokenType": {
|
325
|
-
"base": null,
|
326
|
-
"refs": {
|
327
|
-
"Credentials$SessionToken": "<p>The token that users must pass to the service API to use the temporary credentials.</p>"
|
328
|
-
}
|
329
|
-
},
|
330
|
-
"urlType": {
|
331
|
-
"base": null,
|
332
|
-
"refs": {
|
333
|
-
"AssumeRoleWithWebIdentityRequest$ProviderId": "<p>The fully qualified host component of the domain name of the identity provider.</p> <p>Specify this value only for OAuth 2.0 access tokens. Currently <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.</p> <p>Do not specify this value for OpenID Connect ID tokens. </p>"
|
334
|
-
}
|
335
|
-
},
|
336
|
-
"userNameType": {
|
337
|
-
"base": null,
|
338
|
-
"refs": {
|
339
|
-
"AssumeRoleRequest$RoleSessionName": "<p>An identifier for the assumed role session. The session name is included as part of the <code>AssumedRoleUser</code>. </p>",
|
340
|
-
"AssumeRoleWithWebIdentityRequest$RoleSessionName": "<p>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 <code>AssumedRoleUser</code> response element. </p>",
|
341
|
-
"GetFederationTokenRequest$Name": "<p>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. </p>"
|
342
|
-
}
|
343
|
-
},
|
344
|
-
"webIdentitySubjectType": {
|
345
|
-
"base": null,
|
346
|
-
"refs": {
|
347
|
-
"AssumeRoleWithWebIdentityResponse$SubjectFromWebIdentityToken": "<p>The unique user identifier that is returned by the identity provider. This identifier is associated with the <code>WebIdentityToken</code> that was submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier is typically unique to the user and the application that acquired the <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's <code>sub</code> (Subject) claim. </p>"
|
348
|
-
}
|
349
|
-
}
|
350
|
-
}
|
351
|
-
}
|
@@ -1,680 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"operations": {
|
3
|
-
"AddAttachmentsToSet": "<p>Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p> <p>An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.</p>",
|
4
|
-
"AddCommunicationToCase": "<p>Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication.</p> <p>The response indicates the success or failure of the request.</p> <p>This operation implements a subset of the features of the AWS Support Center.</p>",
|
5
|
-
"CreateCase": "<p>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. Its parameters require you to specify the following information: </p> <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href=\"http://aws.amazon.com/tools/\">AWS SDK</a>. </li> </ol> <note><p>To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>.</p> </note> <p>A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </p>",
|
6
|
-
"DescribeAttachment": "<p>Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation.</p>",
|
7
|
-
"DescribeCases": "<p>Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. </p> <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p> <p>The response returns the following in JSON format:</p> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol>",
|
8
|
-
"DescribeCommunications": "<p>Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case.</p> <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p> <p>You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination.</p>",
|
9
|
-
"DescribeServices": "<p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories.</p> <p>The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.</p>",
|
10
|
-
"DescribeSeverityLevels": "<p>Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </p>",
|
11
|
-
"DescribeTrustedAdvisorCheckRefreshStatuses": "<p>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p>",
|
12
|
-
"DescribeTrustedAdvisorCheckResult": "<p>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects:</p> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <p>In addition, the response contains these fields:</p> <ul> <li> <b>Status.</b> The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul>",
|
13
|
-
"DescribeTrustedAdvisorCheckSummaries": "<p>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects.</p>",
|
14
|
-
"DescribeTrustedAdvisorChecks": "<p>Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check.</p>",
|
15
|
-
"RefreshTrustedAdvisorCheck": "<p>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>.</p> <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields:</p> <ul> <li> <b>Status.</b> The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul>",
|
16
|
-
"ResolveCase": "<p>Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed.</p>"
|
17
|
-
},
|
18
|
-
"service": "<fullname>AWS Support</fullname> <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.</p> <p>The AWS Support service also exposes a set of <a href=\"https://aws.amazon.com/premiumsupport/trustedadvisor/\">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </p> <p>The following list describes the AWS Support case management operations: </p> <ul> <li> <b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li> <li> <b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li> <li> <b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li> </ul> <p>The following list describes the operations available from the AWS Support service for Trusted Advisor:</p> <ul> <li> <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> <li> <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li> <li> <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li> <li> <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li> </ul> <p>For authentication of requests, AWS Support uses <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p> <p>See <a href=\"http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>",
|
19
|
-
"shapes": {
|
20
|
-
"AddAttachmentsToSetRequest": {
|
21
|
-
"base": null,
|
22
|
-
"refs": {
|
23
|
-
}
|
24
|
-
},
|
25
|
-
"AddAttachmentsToSetResponse": {
|
26
|
-
"base": "<p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>",
|
27
|
-
"refs": {
|
28
|
-
}
|
29
|
-
},
|
30
|
-
"AddCommunicationToCaseRequest": {
|
31
|
-
"base": "<p>To be written.</p>",
|
32
|
-
"refs": {
|
33
|
-
}
|
34
|
-
},
|
35
|
-
"AddCommunicationToCaseResponse": {
|
36
|
-
"base": "<p>The result of the <a>AddCommunicationToCase</a> operation.</p>",
|
37
|
-
"refs": {
|
38
|
-
}
|
39
|
-
},
|
40
|
-
"AfterTime": {
|
41
|
-
"base": null,
|
42
|
-
"refs": {
|
43
|
-
"DescribeCasesRequest$afterTime": "<p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>",
|
44
|
-
"DescribeCommunicationsRequest$afterTime": "<p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
|
45
|
-
}
|
46
|
-
},
|
47
|
-
"Attachment": {
|
48
|
-
"base": "<p>An attachment to a case communication. The attachment consists of the file name and the content of the file.</p>",
|
49
|
-
"refs": {
|
50
|
-
"Attachments$member": null,
|
51
|
-
"DescribeAttachmentResponse$attachment": "<p>The attachment content and file name.</p>"
|
52
|
-
}
|
53
|
-
},
|
54
|
-
"AttachmentDetails": {
|
55
|
-
"base": "<p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>",
|
56
|
-
"refs": {
|
57
|
-
"AttachmentSet$member": null
|
58
|
-
}
|
59
|
-
},
|
60
|
-
"AttachmentId": {
|
61
|
-
"base": null,
|
62
|
-
"refs": {
|
63
|
-
"AttachmentDetails$attachmentId": "<p>The ID of the attachment.</p>",
|
64
|
-
"DescribeAttachmentRequest$attachmentId": "<p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>"
|
65
|
-
}
|
66
|
-
},
|
67
|
-
"AttachmentIdNotFound": {
|
68
|
-
"base": "<p>An attachment with the specified ID could not be found.</p>",
|
69
|
-
"refs": {
|
70
|
-
}
|
71
|
-
},
|
72
|
-
"AttachmentLimitExceeded": {
|
73
|
-
"base": "<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>",
|
74
|
-
"refs": {
|
75
|
-
}
|
76
|
-
},
|
77
|
-
"AttachmentSet": {
|
78
|
-
"base": null,
|
79
|
-
"refs": {
|
80
|
-
"Communication$attachmentSet": "<p>Information about the attachments to the case communication. </p>"
|
81
|
-
}
|
82
|
-
},
|
83
|
-
"AttachmentSetExpired": {
|
84
|
-
"base": "<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>",
|
85
|
-
"refs": {
|
86
|
-
}
|
87
|
-
},
|
88
|
-
"AttachmentSetId": {
|
89
|
-
"base": null,
|
90
|
-
"refs": {
|
91
|
-
"AddAttachmentsToSetRequest$attachmentSetId": "<p>The ID of the attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>",
|
92
|
-
"AddAttachmentsToSetResponse$attachmentSetId": "<p>The ID of the attachment set. If an <code>AttachmentSetId</code> was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> was specified, the attachments are added to the specified set, if it exists.</p>",
|
93
|
-
"AddCommunicationToCaseRequest$attachmentSetId": "<p>The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a></p>",
|
94
|
-
"CreateCaseRequest$attachmentSetId": "<p>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</p>"
|
95
|
-
}
|
96
|
-
},
|
97
|
-
"AttachmentSetIdNotFound": {
|
98
|
-
"base": "<p>An attachment set with the specified ID could not be found.</p>",
|
99
|
-
"refs": {
|
100
|
-
}
|
101
|
-
},
|
102
|
-
"AttachmentSetSizeLimitExceeded": {
|
103
|
-
"base": "<p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>",
|
104
|
-
"refs": {
|
105
|
-
}
|
106
|
-
},
|
107
|
-
"Attachments": {
|
108
|
-
"base": null,
|
109
|
-
"refs": {
|
110
|
-
"AddAttachmentsToSetRequest$attachments": "<p>One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.</p>"
|
111
|
-
}
|
112
|
-
},
|
113
|
-
"BeforeTime": {
|
114
|
-
"base": null,
|
115
|
-
"refs": {
|
116
|
-
"DescribeCasesRequest$beforeTime": "<p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>",
|
117
|
-
"DescribeCommunicationsRequest$beforeTime": "<p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>"
|
118
|
-
}
|
119
|
-
},
|
120
|
-
"Boolean": {
|
121
|
-
"base": null,
|
122
|
-
"refs": {
|
123
|
-
"TrustedAdvisorCheckSummary$hasFlaggedResources": "<p>Specifies whether the Trusted Advisor check has flagged resources.</p>",
|
124
|
-
"TrustedAdvisorResourceDetail$isSuppressed": "<p>Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.</p>"
|
125
|
-
}
|
126
|
-
},
|
127
|
-
"CaseCreationLimitExceeded": {
|
128
|
-
"base": "<p>The case creation limit for the account has been exceeded. </p>",
|
129
|
-
"refs": {
|
130
|
-
}
|
131
|
-
},
|
132
|
-
"CaseDetails": {
|
133
|
-
"base": "<p>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p> <ol> <li> <b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</li> <li> <b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a>DescribeServices</a>.</li> <li> <b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li> <li> <b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</li> <li> <b>RecentCommunications.</b> One or more <a>Communication</a> objects. Fields of these objects are <code>Attachments</code>, <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</li> <li> <b>NextToken.</b> A resumption point for pagination.</li> <li> <b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</li> <li> <b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</li> <li> <b>Status.</b> The status of the case in the AWS Support Center.</li> <li> <b>Subject.</b> The subject line of the case.</li> <li> <b>SubmittedBy.</b> The email address of the account that submitted the case.</li> <li> <b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li> </ol>",
|
134
|
-
"refs": {
|
135
|
-
"CaseList$member": null
|
136
|
-
}
|
137
|
-
},
|
138
|
-
"CaseId": {
|
139
|
-
"base": null,
|
140
|
-
"refs": {
|
141
|
-
"AddCommunicationToCaseRequest$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>",
|
142
|
-
"CaseDetails$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>",
|
143
|
-
"CaseIdList$member": null,
|
144
|
-
"Communication$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>",
|
145
|
-
"CreateCaseResponse$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>",
|
146
|
-
"DescribeCommunicationsRequest$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>",
|
147
|
-
"ResolveCaseRequest$caseId": "<p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>"
|
148
|
-
}
|
149
|
-
},
|
150
|
-
"CaseIdList": {
|
151
|
-
"base": null,
|
152
|
-
"refs": {
|
153
|
-
"DescribeCasesRequest$caseIdList": "<p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. </p>"
|
154
|
-
}
|
155
|
-
},
|
156
|
-
"CaseIdNotFound": {
|
157
|
-
"base": "<p>The requested <code>CaseId</code> could not be located.</p>",
|
158
|
-
"refs": {
|
159
|
-
}
|
160
|
-
},
|
161
|
-
"CaseList": {
|
162
|
-
"base": null,
|
163
|
-
"refs": {
|
164
|
-
"DescribeCasesResponse$cases": "<p>The details for the cases that match the request.</p>"
|
165
|
-
}
|
166
|
-
},
|
167
|
-
"CaseStatus": {
|
168
|
-
"base": null,
|
169
|
-
"refs": {
|
170
|
-
"ResolveCaseResponse$initialCaseStatus": "<p>The status of the case when the <a>ResolveCase</a> request was sent.</p>",
|
171
|
-
"ResolveCaseResponse$finalCaseStatus": "<p>The status of the case after the <a>ResolveCase</a> request was processed.</p>"
|
172
|
-
}
|
173
|
-
},
|
174
|
-
"Category": {
|
175
|
-
"base": "<p>A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the <a>DescribeServices</a> response for each AWS service.</p>",
|
176
|
-
"refs": {
|
177
|
-
"CategoryList$member": null
|
178
|
-
}
|
179
|
-
},
|
180
|
-
"CategoryCode": {
|
181
|
-
"base": null,
|
182
|
-
"refs": {
|
183
|
-
"CaseDetails$categoryCode": "<p>The category of problem for the AWS Support case.</p>",
|
184
|
-
"Category$code": "<p>The category code for the support case. </p>",
|
185
|
-
"CreateCaseRequest$categoryCode": "<p>The category of problem for the AWS Support case. </p>"
|
186
|
-
}
|
187
|
-
},
|
188
|
-
"CategoryList": {
|
189
|
-
"base": null,
|
190
|
-
"refs": {
|
191
|
-
"Service$categories": "<p>A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call <a>CreateCase</a>.</p>"
|
192
|
-
}
|
193
|
-
},
|
194
|
-
"CategoryName": {
|
195
|
-
"base": null,
|
196
|
-
"refs": {
|
197
|
-
"Category$name": "<p>The category name for the support case. </p>"
|
198
|
-
}
|
199
|
-
},
|
200
|
-
"CcEmailAddress": {
|
201
|
-
"base": null,
|
202
|
-
"refs": {
|
203
|
-
"CcEmailAddressList$member": null
|
204
|
-
}
|
205
|
-
},
|
206
|
-
"CcEmailAddressList": {
|
207
|
-
"base": null,
|
208
|
-
"refs": {
|
209
|
-
"AddCommunicationToCaseRequest$ccEmailAddresses": "<p>The email addresses in the CC line of an email to be added to the support case.</p>",
|
210
|
-
"CaseDetails$ccEmailAddresses": "<p>The email addresses that receive copies of communication about the case.</p>",
|
211
|
-
"CreateCaseRequest$ccEmailAddresses": "<p>A list of email addresses that AWS Support copies on case correspondence.</p>"
|
212
|
-
}
|
213
|
-
},
|
214
|
-
"Communication": {
|
215
|
-
"base": "<p>A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.</p>",
|
216
|
-
"refs": {
|
217
|
-
"CommunicationList$member": null
|
218
|
-
}
|
219
|
-
},
|
220
|
-
"CommunicationBody": {
|
221
|
-
"base": null,
|
222
|
-
"refs": {
|
223
|
-
"AddCommunicationToCaseRequest$communicationBody": "<p>The body of an email communication to add to the support case.</p>",
|
224
|
-
"Communication$body": "<p>The text of the communication between the customer and AWS Support.</p>",
|
225
|
-
"CreateCaseRequest$communicationBody": "<p>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</p>"
|
226
|
-
}
|
227
|
-
},
|
228
|
-
"CommunicationList": {
|
229
|
-
"base": null,
|
230
|
-
"refs": {
|
231
|
-
"DescribeCommunicationsResponse$communications": "<p>The communications for the case.</p>",
|
232
|
-
"RecentCaseCommunications$communications": "<p>The five most recent communications associated with the case.</p>"
|
233
|
-
}
|
234
|
-
},
|
235
|
-
"CreateCaseRequest": {
|
236
|
-
"base": null,
|
237
|
-
"refs": {
|
238
|
-
}
|
239
|
-
},
|
240
|
-
"CreateCaseResponse": {
|
241
|
-
"base": "<p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> operation. </p>",
|
242
|
-
"refs": {
|
243
|
-
}
|
244
|
-
},
|
245
|
-
"Data": {
|
246
|
-
"base": null,
|
247
|
-
"refs": {
|
248
|
-
"Attachment$data": "<p>The content of the attachment file.</p>"
|
249
|
-
}
|
250
|
-
},
|
251
|
-
"DescribeAttachmentLimitExceeded": {
|
252
|
-
"base": "<p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>",
|
253
|
-
"refs": {
|
254
|
-
}
|
255
|
-
},
|
256
|
-
"DescribeAttachmentRequest": {
|
257
|
-
"base": null,
|
258
|
-
"refs": {
|
259
|
-
}
|
260
|
-
},
|
261
|
-
"DescribeAttachmentResponse": {
|
262
|
-
"base": "<p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>",
|
263
|
-
"refs": {
|
264
|
-
}
|
265
|
-
},
|
266
|
-
"DescribeCasesRequest": {
|
267
|
-
"base": null,
|
268
|
-
"refs": {
|
269
|
-
}
|
270
|
-
},
|
271
|
-
"DescribeCasesResponse": {
|
272
|
-
"base": "<p>Returns an array of <a>CaseDetails</a> objects and a <code>NextToken</code> that defines a point for pagination in the result set.</p>",
|
273
|
-
"refs": {
|
274
|
-
}
|
275
|
-
},
|
276
|
-
"DescribeCommunicationsRequest": {
|
277
|
-
"base": null,
|
278
|
-
"refs": {
|
279
|
-
}
|
280
|
-
},
|
281
|
-
"DescribeCommunicationsResponse": {
|
282
|
-
"base": "<p>The communications returned by the <a>DescribeCommunications</a> operation.</p>",
|
283
|
-
"refs": {
|
284
|
-
}
|
285
|
-
},
|
286
|
-
"DescribeServicesRequest": {
|
287
|
-
"base": null,
|
288
|
-
"refs": {
|
289
|
-
}
|
290
|
-
},
|
291
|
-
"DescribeServicesResponse": {
|
292
|
-
"base": "<p>The list of AWS services returned by the <a>DescribeServices</a> operation.</p>",
|
293
|
-
"refs": {
|
294
|
-
}
|
295
|
-
},
|
296
|
-
"DescribeSeverityLevelsRequest": {
|
297
|
-
"base": null,
|
298
|
-
"refs": {
|
299
|
-
}
|
300
|
-
},
|
301
|
-
"DescribeSeverityLevelsResponse": {
|
302
|
-
"base": "<p>The list of severity levels returned by the <a>DescribeSeverityLevels</a> operation.</p>",
|
303
|
-
"refs": {
|
304
|
-
}
|
305
|
-
},
|
306
|
-
"DescribeTrustedAdvisorCheckRefreshStatusesRequest": {
|
307
|
-
"base": null,
|
308
|
-
"refs": {
|
309
|
-
}
|
310
|
-
},
|
311
|
-
"DescribeTrustedAdvisorCheckRefreshStatusesResponse": {
|
312
|
-
"base": "<p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>",
|
313
|
-
"refs": {
|
314
|
-
}
|
315
|
-
},
|
316
|
-
"DescribeTrustedAdvisorCheckResultRequest": {
|
317
|
-
"base": null,
|
318
|
-
"refs": {
|
319
|
-
}
|
320
|
-
},
|
321
|
-
"DescribeTrustedAdvisorCheckResultResponse": {
|
322
|
-
"base": "<p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>",
|
323
|
-
"refs": {
|
324
|
-
}
|
325
|
-
},
|
326
|
-
"DescribeTrustedAdvisorCheckSummariesRequest": {
|
327
|
-
"base": null,
|
328
|
-
"refs": {
|
329
|
-
}
|
330
|
-
},
|
331
|
-
"DescribeTrustedAdvisorCheckSummariesResponse": {
|
332
|
-
"base": "<p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>",
|
333
|
-
"refs": {
|
334
|
-
}
|
335
|
-
},
|
336
|
-
"DescribeTrustedAdvisorChecksRequest": {
|
337
|
-
"base": null,
|
338
|
-
"refs": {
|
339
|
-
}
|
340
|
-
},
|
341
|
-
"DescribeTrustedAdvisorChecksResponse": {
|
342
|
-
"base": "<p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>",
|
343
|
-
"refs": {
|
344
|
-
}
|
345
|
-
},
|
346
|
-
"DisplayId": {
|
347
|
-
"base": null,
|
348
|
-
"refs": {
|
349
|
-
"CaseDetails$displayId": "<p>The ID displayed for the case in the AWS Support Center. This is a numeric string. </p>",
|
350
|
-
"DescribeCasesRequest$displayId": "<p>The ID displayed for a case in the AWS Support Center user interface. </p>"
|
351
|
-
}
|
352
|
-
},
|
353
|
-
"Double": {
|
354
|
-
"base": null,
|
355
|
-
"refs": {
|
356
|
-
"TrustedAdvisorCostOptimizingSummary$estimatedMonthlySavings": "<p>The estimated monthly savings that might be realized if the recommended actions are taken.</p>",
|
357
|
-
"TrustedAdvisorCostOptimizingSummary$estimatedPercentMonthlySavings": "<p>The estimated percentage of savings that might be realized if the recommended actions are taken.</p>"
|
358
|
-
}
|
359
|
-
},
|
360
|
-
"ErrorMessage": {
|
361
|
-
"base": null,
|
362
|
-
"refs": {
|
363
|
-
"AttachmentIdNotFound$message": "<p>An attachment with the specified ID could not be found.</p>",
|
364
|
-
"AttachmentLimitExceeded$message": "<p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>",
|
365
|
-
"AttachmentSetExpired$message": "<p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>",
|
366
|
-
"AttachmentSetIdNotFound$message": "<p>An attachment set with the specified ID could not be found.</p>",
|
367
|
-
"AttachmentSetSizeLimitExceeded$message": "<p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>",
|
368
|
-
"CaseCreationLimitExceeded$message": "<p>An error message that indicates that you have exceeded the number of cases you can have open. </p>",
|
369
|
-
"CaseIdNotFound$message": "<p>The requested <code>CaseId</code> could not be located.</p>",
|
370
|
-
"DescribeAttachmentLimitExceeded$message": "<p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>",
|
371
|
-
"InternalServerError$message": "<p>An internal server error occurred.</p>"
|
372
|
-
}
|
373
|
-
},
|
374
|
-
"ExpiryTime": {
|
375
|
-
"base": null,
|
376
|
-
"refs": {
|
377
|
-
"AddAttachmentsToSetResponse$expiryTime": "<p>The time and date when the attachment set expires.</p>"
|
378
|
-
}
|
379
|
-
},
|
380
|
-
"FileName": {
|
381
|
-
"base": null,
|
382
|
-
"refs": {
|
383
|
-
"Attachment$fileName": "<p>The name of the attachment file.</p>",
|
384
|
-
"AttachmentDetails$fileName": "<p>The file name of the attachment.</p>"
|
385
|
-
}
|
386
|
-
},
|
387
|
-
"IncludeCommunications": {
|
388
|
-
"base": null,
|
389
|
-
"refs": {
|
390
|
-
"DescribeCasesRequest$includeCommunications": "<p>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</p>"
|
391
|
-
}
|
392
|
-
},
|
393
|
-
"IncludeResolvedCases": {
|
394
|
-
"base": null,
|
395
|
-
"refs": {
|
396
|
-
"DescribeCasesRequest$includeResolvedCases": "<p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</p>"
|
397
|
-
}
|
398
|
-
},
|
399
|
-
"InternalServerError": {
|
400
|
-
"base": "<p>An internal server error occurred.</p>",
|
401
|
-
"refs": {
|
402
|
-
}
|
403
|
-
},
|
404
|
-
"IssueType": {
|
405
|
-
"base": null,
|
406
|
-
"refs": {
|
407
|
-
"CreateCaseRequest$issueType": "<p>The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </p>"
|
408
|
-
}
|
409
|
-
},
|
410
|
-
"Language": {
|
411
|
-
"base": null,
|
412
|
-
"refs": {
|
413
|
-
"CaseDetails$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
414
|
-
"CreateCaseRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
415
|
-
"DescribeCasesRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
416
|
-
"DescribeServicesRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
417
|
-
"DescribeSeverityLevelsRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>"
|
418
|
-
}
|
419
|
-
},
|
420
|
-
"Long": {
|
421
|
-
"base": null,
|
422
|
-
"refs": {
|
423
|
-
"TrustedAdvisorCheckRefreshStatus$millisUntilNextRefreshable": "<p>The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.</p>",
|
424
|
-
"TrustedAdvisorResourcesSummary$resourcesProcessed": "<p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>",
|
425
|
-
"TrustedAdvisorResourcesSummary$resourcesFlagged": "<p>The number of AWS resources that were flagged (listed) by the Trusted Advisor check.</p>",
|
426
|
-
"TrustedAdvisorResourcesSummary$resourcesIgnored": "<p>The number of AWS resources ignored by Trusted Advisor because information was unavailable.</p>",
|
427
|
-
"TrustedAdvisorResourcesSummary$resourcesSuppressed": "<p>The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.</p>"
|
428
|
-
}
|
429
|
-
},
|
430
|
-
"MaxResults": {
|
431
|
-
"base": null,
|
432
|
-
"refs": {
|
433
|
-
"DescribeCasesRequest$maxResults": "<p>The maximum number of results to return before paginating.</p>",
|
434
|
-
"DescribeCommunicationsRequest$maxResults": "<p>The maximum number of results to return before paginating.</p>"
|
435
|
-
}
|
436
|
-
},
|
437
|
-
"NextToken": {
|
438
|
-
"base": null,
|
439
|
-
"refs": {
|
440
|
-
"DescribeCasesRequest$nextToken": "<p>A resumption point for pagination.</p>",
|
441
|
-
"DescribeCasesResponse$nextToken": "<p>A resumption point for pagination.</p>",
|
442
|
-
"DescribeCommunicationsRequest$nextToken": "<p>A resumption point for pagination.</p>",
|
443
|
-
"DescribeCommunicationsResponse$nextToken": "<p>A resumption point for pagination.</p>",
|
444
|
-
"RecentCaseCommunications$nextToken": "<p>A resumption point for pagination.</p>"
|
445
|
-
}
|
446
|
-
},
|
447
|
-
"RecentCaseCommunications": {
|
448
|
-
"base": "<p>The five most recent communications associated with the case.</p>",
|
449
|
-
"refs": {
|
450
|
-
"CaseDetails$recentCommunications": "<p>The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a <code>nextToken</code> that you can use to retrieve earlier communications.</p>"
|
451
|
-
}
|
452
|
-
},
|
453
|
-
"RefreshTrustedAdvisorCheckRequest": {
|
454
|
-
"base": null,
|
455
|
-
"refs": {
|
456
|
-
}
|
457
|
-
},
|
458
|
-
"RefreshTrustedAdvisorCheckResponse": {
|
459
|
-
"base": "<p>The current refresh status of a Trusted Advisor check.</p>",
|
460
|
-
"refs": {
|
461
|
-
}
|
462
|
-
},
|
463
|
-
"ResolveCaseRequest": {
|
464
|
-
"base": null,
|
465
|
-
"refs": {
|
466
|
-
}
|
467
|
-
},
|
468
|
-
"ResolveCaseResponse": {
|
469
|
-
"base": "<p>The status of the case returned by the <a>ResolveCase</a> operation.</p>",
|
470
|
-
"refs": {
|
471
|
-
}
|
472
|
-
},
|
473
|
-
"Result": {
|
474
|
-
"base": null,
|
475
|
-
"refs": {
|
476
|
-
"AddCommunicationToCaseResponse$result": "<p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>"
|
477
|
-
}
|
478
|
-
},
|
479
|
-
"Service": {
|
480
|
-
"base": "<p>Information about an AWS service returned by the <a>DescribeServices</a> operation. </p>",
|
481
|
-
"refs": {
|
482
|
-
"ServiceList$member": null
|
483
|
-
}
|
484
|
-
},
|
485
|
-
"ServiceCode": {
|
486
|
-
"base": null,
|
487
|
-
"refs": {
|
488
|
-
"CaseDetails$serviceCode": "<p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>",
|
489
|
-
"CreateCaseRequest$serviceCode": "<p>The code for the AWS service returned by the call to <a>DescribeServices</a>.</p>",
|
490
|
-
"Service$code": "<p>The code for an AWS service returned by the <a>DescribeServices</a> response. The <code>Name</code> element contains the corresponding friendly name.</p>",
|
491
|
-
"ServiceCodeList$member": null
|
492
|
-
}
|
493
|
-
},
|
494
|
-
"ServiceCodeList": {
|
495
|
-
"base": null,
|
496
|
-
"refs": {
|
497
|
-
"DescribeServicesRequest$serviceCodeList": "<p>A JSON-formatted list of service codes available for AWS services.</p>"
|
498
|
-
}
|
499
|
-
},
|
500
|
-
"ServiceList": {
|
501
|
-
"base": null,
|
502
|
-
"refs": {
|
503
|
-
"DescribeServicesResponse$services": "<p>A JSON-formatted list of AWS services.</p>"
|
504
|
-
}
|
505
|
-
},
|
506
|
-
"ServiceName": {
|
507
|
-
"base": null,
|
508
|
-
"refs": {
|
509
|
-
"Service$name": "<p>The friendly name for an AWS service. The <code>Code</code> element contains the corresponding code.</p>"
|
510
|
-
}
|
511
|
-
},
|
512
|
-
"SeverityCode": {
|
513
|
-
"base": null,
|
514
|
-
"refs": {
|
515
|
-
"CaseDetails$severityCode": "<p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p>",
|
516
|
-
"CreateCaseRequest$severityCode": "<p>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</p> <note><p>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</p></note>"
|
517
|
-
}
|
518
|
-
},
|
519
|
-
"SeverityLevel": {
|
520
|
-
"base": "<p>A code and name pair that represent a severity level that can be applied to a support case. </p>",
|
521
|
-
"refs": {
|
522
|
-
"SeverityLevelsList$member": null
|
523
|
-
}
|
524
|
-
},
|
525
|
-
"SeverityLevelCode": {
|
526
|
-
"base": null,
|
527
|
-
"refs": {
|
528
|
-
"SeverityLevel$code": "<p>One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in <code>SeverityLevel.name</code>. </p>"
|
529
|
-
}
|
530
|
-
},
|
531
|
-
"SeverityLevelName": {
|
532
|
-
"base": null,
|
533
|
-
"refs": {
|
534
|
-
"SeverityLevel$name": "<p>The name of the severity level that corresponds to the severity level code.</p>"
|
535
|
-
}
|
536
|
-
},
|
537
|
-
"SeverityLevelsList": {
|
538
|
-
"base": null,
|
539
|
-
"refs": {
|
540
|
-
"DescribeSeverityLevelsResponse$severityLevels": "<p>The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>"
|
541
|
-
}
|
542
|
-
},
|
543
|
-
"Status": {
|
544
|
-
"base": null,
|
545
|
-
"refs": {
|
546
|
-
"CaseDetails$status": "<p>The status of the case. </p>"
|
547
|
-
}
|
548
|
-
},
|
549
|
-
"String": {
|
550
|
-
"base": null,
|
551
|
-
"refs": {
|
552
|
-
"DescribeTrustedAdvisorCheckResultRequest$checkId": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
553
|
-
"DescribeTrustedAdvisorCheckResultRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
554
|
-
"DescribeTrustedAdvisorChecksRequest$language": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>",
|
555
|
-
"RefreshTrustedAdvisorCheckRequest$checkId": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
556
|
-
"StringList$member": null,
|
557
|
-
"TrustedAdvisorCheckDescription$id": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
558
|
-
"TrustedAdvisorCheckDescription$name": "<p>The display name for the Trusted Advisor check.</p>",
|
559
|
-
"TrustedAdvisorCheckDescription$description": "<p>The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).</p>",
|
560
|
-
"TrustedAdvisorCheckDescription$category": "<p>The category of the Trusted Advisor check.</p>",
|
561
|
-
"TrustedAdvisorCheckRefreshStatus$checkId": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
562
|
-
"TrustedAdvisorCheckRefreshStatus$status": "<p>The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".</p>",
|
563
|
-
"TrustedAdvisorCheckResult$checkId": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
564
|
-
"TrustedAdvisorCheckResult$timestamp": "<p>The time of the last refresh of the check.</p>",
|
565
|
-
"TrustedAdvisorCheckResult$status": "<p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>",
|
566
|
-
"TrustedAdvisorCheckSummary$checkId": "<p>The unique identifier for the Trusted Advisor check.</p>",
|
567
|
-
"TrustedAdvisorCheckSummary$timestamp": "<p>The time of the last refresh of the check.</p>",
|
568
|
-
"TrustedAdvisorCheckSummary$status": "<p>The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".</p>",
|
569
|
-
"TrustedAdvisorResourceDetail$status": "<p>The status code for the resource identified in the Trusted Advisor check.</p>",
|
570
|
-
"TrustedAdvisorResourceDetail$region": "<p>The AWS region in which the identified resource is located. </p>",
|
571
|
-
"TrustedAdvisorResourceDetail$resourceId": "<p>The unique identifier for the identified resource.</p>"
|
572
|
-
}
|
573
|
-
},
|
574
|
-
"StringList": {
|
575
|
-
"base": null,
|
576
|
-
"refs": {
|
577
|
-
"DescribeTrustedAdvisorCheckRefreshStatusesRequest$checkIds": "<p>The IDs of the Trusted Advisor checks.</p>",
|
578
|
-
"DescribeTrustedAdvisorCheckSummariesRequest$checkIds": "<p>The IDs of the Trusted Advisor checks.</p>",
|
579
|
-
"TrustedAdvisorCheckDescription$metadata": "<p>The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>",
|
580
|
-
"TrustedAdvisorResourceDetail$metadata": "<p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>"
|
581
|
-
}
|
582
|
-
},
|
583
|
-
"Subject": {
|
584
|
-
"base": null,
|
585
|
-
"refs": {
|
586
|
-
"CaseDetails$subject": "<p>The subject line for the case in the AWS Support Center.</p>",
|
587
|
-
"CreateCaseRequest$subject": "<p>The title of the AWS Support case.</p>"
|
588
|
-
}
|
589
|
-
},
|
590
|
-
"SubmittedBy": {
|
591
|
-
"base": null,
|
592
|
-
"refs": {
|
593
|
-
"CaseDetails$submittedBy": "<p>The email address of the account that submitted the case.</p>",
|
594
|
-
"Communication$submittedBy": "<p>The email address of the account that submitted the AWS Support case. </p>"
|
595
|
-
}
|
596
|
-
},
|
597
|
-
"TimeCreated": {
|
598
|
-
"base": null,
|
599
|
-
"refs": {
|
600
|
-
"CaseDetails$timeCreated": "<p>The time that the case was case created in the AWS Support Center. </p>",
|
601
|
-
"Communication$timeCreated": "<p>The time the communication was created. </p>"
|
602
|
-
}
|
603
|
-
},
|
604
|
-
"TrustedAdvisorCategorySpecificSummary": {
|
605
|
-
"base": "<p>The container for summary information that relates to the category of the Trusted Advisor check.</p>",
|
606
|
-
"refs": {
|
607
|
-
"TrustedAdvisorCheckResult$categorySpecificSummary": "<p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>",
|
608
|
-
"TrustedAdvisorCheckSummary$categorySpecificSummary": "<p>Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.</p>"
|
609
|
-
}
|
610
|
-
},
|
611
|
-
"TrustedAdvisorCheckDescription": {
|
612
|
-
"base": "<p>The description and metadata for a Trusted Advisor check.</p>",
|
613
|
-
"refs": {
|
614
|
-
"TrustedAdvisorCheckList$member": null
|
615
|
-
}
|
616
|
-
},
|
617
|
-
"TrustedAdvisorCheckList": {
|
618
|
-
"base": null,
|
619
|
-
"refs": {
|
620
|
-
"DescribeTrustedAdvisorChecksResponse$checks": "<p>Information about all available Trusted Advisor checks.</p>"
|
621
|
-
}
|
622
|
-
},
|
623
|
-
"TrustedAdvisorCheckRefreshStatus": {
|
624
|
-
"base": "<p>The refresh status of a Trusted Advisor check. </p>",
|
625
|
-
"refs": {
|
626
|
-
"RefreshTrustedAdvisorCheckResponse$status": "<p>The current refresh status for a check, including the amount of time until the check is eligible for refresh. </p>",
|
627
|
-
"TrustedAdvisorCheckRefreshStatusList$member": null
|
628
|
-
}
|
629
|
-
},
|
630
|
-
"TrustedAdvisorCheckRefreshStatusList": {
|
631
|
-
"base": null,
|
632
|
-
"refs": {
|
633
|
-
"DescribeTrustedAdvisorCheckRefreshStatusesResponse$statuses": "<p>The refresh status of the specified Trusted Advisor checks.</p>"
|
634
|
-
}
|
635
|
-
},
|
636
|
-
"TrustedAdvisorCheckResult": {
|
637
|
-
"base": "<p>The results of a Trusted Advisor check returned by <a>DescribeTrustedAdvisorCheckResult</a>.</p>",
|
638
|
-
"refs": {
|
639
|
-
"DescribeTrustedAdvisorCheckResultResponse$result": "<p>The detailed results of the Trusted Advisor check.</p>"
|
640
|
-
}
|
641
|
-
},
|
642
|
-
"TrustedAdvisorCheckSummary": {
|
643
|
-
"base": "<p>A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.</p>",
|
644
|
-
"refs": {
|
645
|
-
"TrustedAdvisorCheckSummaryList$member": null
|
646
|
-
}
|
647
|
-
},
|
648
|
-
"TrustedAdvisorCheckSummaryList": {
|
649
|
-
"base": null,
|
650
|
-
"refs": {
|
651
|
-
"DescribeTrustedAdvisorCheckSummariesResponse$summaries": "<p>The summary information for the requested Trusted Advisor checks.</p>"
|
652
|
-
}
|
653
|
-
},
|
654
|
-
"TrustedAdvisorCostOptimizingSummary": {
|
655
|
-
"base": "<p>The estimated cost savings that might be realized if the recommended actions are taken.</p>",
|
656
|
-
"refs": {
|
657
|
-
"TrustedAdvisorCategorySpecificSummary$costOptimizing": "<p>The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.</p>"
|
658
|
-
}
|
659
|
-
},
|
660
|
-
"TrustedAdvisorResourceDetail": {
|
661
|
-
"base": "<p>Contains information about a resource identified by a Trusted Advisor check. </p>",
|
662
|
-
"refs": {
|
663
|
-
"TrustedAdvisorResourceDetailList$member": null
|
664
|
-
}
|
665
|
-
},
|
666
|
-
"TrustedAdvisorResourceDetailList": {
|
667
|
-
"base": null,
|
668
|
-
"refs": {
|
669
|
-
"TrustedAdvisorCheckResult$flaggedResources": "<p>The details about each resource listed in the check result.</p>"
|
670
|
-
}
|
671
|
-
},
|
672
|
-
"TrustedAdvisorResourcesSummary": {
|
673
|
-
"base": "<p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </p>",
|
674
|
-
"refs": {
|
675
|
-
"TrustedAdvisorCheckResult$resourcesSummary": null,
|
676
|
-
"TrustedAdvisorCheckSummary$resourcesSummary": null
|
677
|
-
}
|
678
|
-
}
|
679
|
-
}
|
680
|
-
}
|