{ "smithy": "2.0", "shapes": { "com.amazonaws.signin#AccessDeniedException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "One of TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason access was denied.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "You do not have sufficient access to perform this action.", "smithy.api#error": "client" } }, "com.amazonaws.signin#AccessToken": { "type": "structure", "members": { "accessKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The AWS access key ID for the temporary credentials.", "smithy.api#jsonName": "accessKeyId", "smithy.api#required": {} } }, "secretAccessKey": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The AWS secret access key used to sign requests.", "smithy.api#jsonName": "secretAccessKey", "smithy.api#required": {} } }, "sessionToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The session token that validates the temporary security credentials.", "smithy.api#jsonName": "sessionToken", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the scoped, temporary AWS credentials used to sign requests with SigV4. Valid for 15 minutes.", "smithy.api#sensitive": {} } }, "com.amazonaws.signin#AccountId": { "type": "string", "traits": { "smithy.api#documentation": "AWS account identifier", "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.signin#Assertion": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 20000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.signin#AuthorizationCode": { "type": "string", "traits": { "smithy.api#documentation": "Authorization code received from AWS Sign-In. Used only in the authorization code redemption flow.", "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.signin#BatchRevokeSessionError": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The session ARN", "smithy.api#required": {} } }, "code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error code", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error message", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A session that could not be revoked" } }, "com.amazonaws.signin#BatchRevokeSessionErrorList": { "type": "list", "member": { "target": "com.amazonaws.signin#BatchRevokeSessionError" } }, "com.amazonaws.signin#BatchRevokeSessions": { "type": "operation", "input": { "target": "com.amazonaws.signin#BatchRevokeSessionsInput" }, "output": { "target": "com.amazonaws.signin#BatchRevokeSessionsOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Revoke one or more sign-in sessions" }, "smithy.api#documentation": "Revokes up to five sign-in sessions. A revoked session can no longer be refreshed. Revoking a session that is\nalready revoked succeeds. Each session must belong to the identity specified by principalArn, or to the caller if\nprincipalArn is omitted. Failures for individual sessions are returned in the errors list and do not fail the\nwhole request.", "smithy.api#examples": [ { "title": "Revoke one of your own sessions", "documentation": "Revokes a session owned by the caller and records the reason.", "input": { "sessionArns": [ "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7" ], "reason": "Signed out of a lost device" }, "output": { "revokedSessions": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7" } ], "errors": [] } }, { "title": "Revoke another identity's session as an account administrator", "documentation": "Uses the account wildcard principal ARN to revoke another IAM identity's session.", "input": { "principalArn": "arn:aws:iam::123456789012:*", "sessionArns": [ "arn:aws:signin:us-east-1:123456789012:session/5dbdd43b-4135-4c59-ad06-5ddbcc2c1d77" ], "reason": "Revoked by account administrator" }, "output": { "revokedSessions": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/5dbdd43b-4135-4c59-ad06-5ddbcc2c1d77" } ], "errors": [] } }, { "title": "Revoke a batch of sessions with a partial failure", "documentation": "Revokes the caller's session and reports a session that was not found in the errors list.", "input": { "sessionArns": [ "arn:aws:signin:us-east-1:123456789012:session/ac148df8-7f37-48eb-b0cf-8987fc4a55a4", "arn:aws:signin:us-east-1:123456789012:session/36b6ae9d-4fa9-40d9-8eff-eeeb4d15f79d" ] }, "output": { "revokedSessions": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/ac148df8-7f37-48eb-b0cf-8987fc4a55a4" } ], "errors": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/36b6ae9d-4fa9-40d9-8eff-eeeb4d15f79d", "code": "ResourceNotFoundException", "message": "No session found for the given sessionArn" } ] } } ], "smithy.api#http": { "method": "POST", "uri": "/batch-revoke-sessions" }, "smithy.api#idempotent": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#BatchRevokeSessionsInput": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.signin#PrincipalArnFilter", "traits": { "smithy.api#documentation": "The identity that owns the sessions. Omit to use the caller. Specify arn:aws:iam::{account-id}:* to revoke\nany session in the account." } }, "sessionArns": { "target": "com.amazonaws.signin#SessionArnList", "traits": { "smithy.api#documentation": "The ARNs of the sessions to revoke", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.signin#RevocationReason", "traits": { "smithy.api#documentation": "The reason for revoking the sessions" } } }, "traits": { "smithy.api#documentation": "Input for BatchRevokeSessions operation", "smithy.api#input": {} } }, "com.amazonaws.signin#BatchRevokeSessionsOutput": { "type": "structure", "members": { "revokedSessions": { "target": "com.amazonaws.signin#RevokedSessionList", "traits": { "smithy.api#documentation": "Sessions that were revoked", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.signin#BatchRevokeSessionErrorList", "traits": { "smithy.api#documentation": "Sessions that could not be revoked", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for BatchRevokeSessions operation", "smithy.api#output": {} } }, "com.amazonaws.signin#BearerTokenExpiresIn": { "type": "integer", "traits": { "smithy.api#documentation": "Token lifetime in seconds.", "smithy.api#range": { "min": 1 } } }, "com.amazonaws.signin#BearerTokenType": { "type": "string", "traits": { "smithy.api#documentation": "Token type for access tokens. Currently supports \"Bearer\" as defined in RFC 6749.", "smithy.api#pattern": "^Bearer$" } }, "com.amazonaws.signin#ClientCredentialsGrantType": { "type": "string", "traits": { "smithy.api#documentation": "OAuth 2.0 grant type for client_credentials flow.", "smithy.api#pattern": "^client_credentials$" } }, "com.amazonaws.signin#ClientId": { "type": "string", "traits": { "smithy.api#documentation": "The OAuth 2.0 client identifier.", "smithy.api#pattern": "^arn:aws:signin:::devtools/(cross-device|same-device)$" } }, "com.amazonaws.signin#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "Idempotency token", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.signin#ClientType": { "type": "enum", "members": { "CLI": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The AWS CLI", "smithy.api#enumValue": "CLI" } }, "MCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "An MCP server", "smithy.api#enumValue": "MCP" } } }, "traits": { "smithy.api#documentation": "Type of OAuth client that created a session" } }, "com.amazonaws.signin#CodeVerifier": { "type": "string", "traits": { "smithy.api#documentation": "PKCE code verifier used to prove possession of the original code challenge. Must be 43 to 128 characters.", "smithy.api#length": { "min": 43, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9\\-._~]+$" } }, "com.amazonaws.signin#Condition": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "com.amazonaws.signin#ConditionValues" }, "traits": { "smithy.api#documentation": "Condition mapping of keys to values" } }, "com.amazonaws.signin#ConditionBlock": { "type": "map", "key": { "target": "com.amazonaws.signin#ConditionType" }, "value": { "target": "com.amazonaws.signin#Condition" }, "traits": { "smithy.api#documentation": "Condition block for policy statements" } }, "com.amazonaws.signin#ConditionType": { "type": "string", "traits": { "smithy.api#documentation": "Condition type identifier" } }, "com.amazonaws.signin#ConditionValues": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "List of condition values" } }, "com.amazonaws.signin#ConflictException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "OAuth 2.0 error code indicating conflict\nWill be CONFLICT", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed message explaining the conflict\nProvides specific information about what caused the conflict", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Error thrown when request conflicts with current state\n\nHTTP Status Code: 409 Conflict\n\nUsed when the request conflicts with the current state of the resource", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.signin#ConsolePermissionMaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "Maximum number of results for list operations", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.signin#CreateBearerToken": { "type": "operation", "input": { "target": "com.amazonaws.signin#CreateBearerTokenRequest" }, "output": { "target": "com.amazonaws.signin#CreateBearerTokenResponse" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "CreateBearerToken", "documentation": "Grants permission to create a bearer token for a supported AWS service using SigV4 credentials" }, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "Creates a bearer token that represents your IAM credentials and can be used to access a supported AWS service. By default, the token is valid for 12 hours.", "smithy.api#http": { "method": "POST", "uri": "/v1/token?x-amz-token-request-type=bearer" }, "smithy.rules#staticContextParams": { "IsOAuthEndpoint": { "value": true } } } }, "com.amazonaws.signin#CreateBearerTokenRequest": { "type": "structure", "members": { "grantType": { "target": "com.amazonaws.signin#ClientCredentialsGrantType", "traits": { "smithy.api#documentation": "The grant type. Must be \"client_credentials\".", "smithy.api#jsonName": "grant_type", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.signin#Resource", "traits": { "smithy.api#documentation": "The AWS service the bearer token is for.\nExample: \"ecr.amazonaws.com\".", "smithy.api#required": {} } }, "durationSeconds": { "target": "com.amazonaws.signin#TokenDuration", "traits": { "smithy.api#documentation": "The requested token lifetime in seconds, from 300 (5 minutes) up to the maximum allowed for the service, currently 43200 (12 hours). If omitted, the token is valid for 12 hours.", "smithy.api#jsonName": "duration" } } }, "traits": { "smithy.api#documentation": "Input structure for CreateBearerToken operation", "smithy.api#input": {} } }, "com.amazonaws.signin#CreateBearerTokenResponse": { "type": "structure", "members": { "accessToken": { "target": "com.amazonaws.signin#OAuthAccessToken", "traits": { "smithy.api#documentation": "The bearer token. Present it to the AWS service named in the request.", "smithy.api#jsonName": "access_token", "smithy.api#required": {} } }, "tokenType": { "target": "com.amazonaws.signin#BearerTokenType", "traits": { "smithy.api#documentation": "The token type. Always \"Bearer\".", "smithy.api#jsonName": "token_type", "smithy.api#required": {} } }, "expiresIn": { "target": "com.amazonaws.signin#BearerTokenExpiresIn", "traits": { "smithy.api#documentation": "Token lifetime in seconds.", "smithy.api#jsonName": "expires_in", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output structure for CreateBearerToken operation\n\nContains the bearer token, its type, and its lifetime.", "smithy.api#output": {} } }, "com.amazonaws.signin#CreateOAuth2Token": { "type": "operation", "input": { "target": "com.amazonaws.signin#CreateOAuth2TokenRequest" }, "output": { "target": "com.amazonaws.signin#CreateOAuth2TokenResponse" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Exchanges an authorization code or refresh token for an OAuth 2.0 access token and refresh token.", "smithy.api#http": { "method": "POST", "uri": "/v1/token" }, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": false } }, "smithy.test#smokeTests": [ { "id": "TokenOperationSmokeTest", "params": { "tokenInput": { "clientId": "arn:aws:signin:::devtools/same-device", "grantType": "authorization_code", "code": "test-code", "redirectUri": "https://example.com", "codeVerifier": "test-code-verifier-1234567890abcdefghijklmnop" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": {}, "expect": { "failure": {} } } ] } }, "com.amazonaws.signin#CreateOAuth2TokenRequest": { "type": "structure", "members": { "tokenInput": { "target": "com.amazonaws.signin#CreateOAuth2TokenRequestBody", "traits": { "smithy.api#documentation": "Flattened token operation inputs. The \"grant_type\" in the request body determines the specific operation.", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Input structure for CreateOAuth2Token operation\n\nContains flattened token operation inputs for both authorization code and refresh token flows.\nThe operation type is determined by the grant_type parameter in the request body.", "smithy.api#input": {} } }, "com.amazonaws.signin#CreateOAuth2TokenRequestBody": { "type": "structure", "members": { "clientId": { "target": "com.amazonaws.signin#ClientId", "traits": { "smithy.api#documentation": "The OAuth 2.0 client identifier. Expected values: \"arn:aws:signin:::devtools/same-device\"\nor \"arn:aws:signin:::devtools/cross-device\".", "smithy.api#jsonName": "clientId", "smithy.api#required": {} } }, "grantType": { "target": "com.amazonaws.signin#GrantType", "traits": { "smithy.api#documentation": "The OAuth 2.0 grant type. Supported values:\n- \"authorization_code\" - Exchange an authorization code for tokens.\n- \"refresh_token\" - Use a refresh token to obtain a new access token.", "smithy.api#jsonName": "grantType", "smithy.api#required": {} } }, "code": { "target": "com.amazonaws.signin#AuthorizationCode", "traits": { "smithy.api#documentation": "The authorization code received from the \"/v1/authorize\" endpoint.\nRequired when \"grant_type=authorization_code\"." } }, "redirectUri": { "target": "com.amazonaws.signin#RedirectUri", "traits": { "smithy.api#documentation": "The redirect URI that was used in the original authorization request. Must match exactly.\nRequired when \"grant_type=authorization_code\".", "smithy.api#jsonName": "redirectUri" } }, "codeVerifier": { "target": "com.amazonaws.signin#CodeVerifier", "traits": { "smithy.api#documentation": "The PKCE code verifier that proves possession of the original code challenge.\nRequired when \"grant_type=authorization_code\".", "smithy.api#jsonName": "codeVerifier" } }, "refreshToken": { "target": "com.amazonaws.signin#RefreshToken", "traits": { "smithy.api#documentation": "The refresh token issued by a previous token response.\nRequired when \"grant_type=refresh_token\".", "smithy.api#jsonName": "refreshToken" } } }, "traits": { "smithy.api#documentation": "The request body for creating an OAuth 2.0 token. Supports both the authorization code and\nrefresh token flows, selected by the \"grant_type\" parameter." } }, "com.amazonaws.signin#CreateOAuth2TokenResponse": { "type": "structure", "members": { "tokenOutput": { "target": "com.amazonaws.signin#CreateOAuth2TokenResponseBody", "traits": { "smithy.api#documentation": "Flattened token operation outputs.\nThe specific response fields depend on the grant_type used in the request.", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output structure for CreateOAuth2Token operation\n\nContains flattened token operation outputs for both authorization code and refresh token flows.\nThe response content depends on the grant_type from the original request.", "smithy.api#output": {} } }, "com.amazonaws.signin#CreateOAuth2TokenResponseBody": { "type": "structure", "members": { "accessToken": { "target": "com.amazonaws.signin#AccessToken", "traits": { "smithy.api#documentation": "The access token issued by the authorization server. The token contains temporary\nAWS security credentials that you use to sign requests with SigV4.", "smithy.api#jsonName": "accessToken", "smithy.api#required": {} } }, "tokenType": { "target": "com.amazonaws.signin#TokenType", "traits": { "smithy.api#documentation": "The type of token issued. Value is \"aws_sigv4\".", "smithy.api#jsonName": "tokenType", "smithy.api#required": {} } }, "expiresIn": { "target": "com.amazonaws.signin#ExpiresIn", "traits": { "smithy.api#documentation": "The number of seconds until the access token expires. Maximum value is 900 seconds (15 minutes).", "smithy.api#jsonName": "expiresIn", "smithy.api#required": {} } }, "refreshToken": { "target": "com.amazonaws.signin#RefreshToken", "traits": { "smithy.api#documentation": "A refresh token that can be used to obtain new access tokens without re-authenticating.", "smithy.api#jsonName": "refreshToken", "smithy.api#required": {} } }, "idToken": { "target": "com.amazonaws.signin#IdToken", "traits": { "smithy.api#documentation": "A JSON Web Token (JWT) containing user identity claims. Present only when\n\"grant_type=authorization_code\". Not included in refresh token responses.", "smithy.api#jsonName": "idToken" } } }, "traits": { "smithy.api#documentation": "The response body for an OAuth 2.0 token request. The fields returned depend on the \"grant_type\".\nThe authorization code flow returns \"refresh_token\" and \"id_token\". The refresh token flow omits \"id_token\"." } }, "com.amazonaws.signin#CreateOAuth2TokenWithIAM": { "type": "operation", "input": { "target": "com.amazonaws.signin#CreateOAuth2TokenWithIAMRequest" }, "output": { "target": "com.amazonaws.signin#CreateOAuth2TokenWithIAMResponse" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "CreateOAuth2Token", "documentation": "Exchange client credentials for an OAuth 2.0 access token scoped to a resource" }, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "Exchanges client credentials for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.", "smithy.api#http": { "method": "POST", "uri": "/v1/token?x-amz-client-auth-method=iam" }, "smithy.rules#staticContextParams": { "IsOAuthEndpoint": { "value": true } } } }, "com.amazonaws.signin#CreateOAuth2TokenWithIAMRequest": { "type": "structure", "members": { "grantType": { "target": "com.amazonaws.signin#ClientCredentialsGrantType", "traits": { "smithy.api#documentation": "The OAuth 2.0 grant type. Must be \"client_credentials\".", "smithy.api#jsonName": "grant_type", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.signin#Resource", "traits": { "smithy.api#documentation": "The OAuth resource for which the access token is requested.\nExample: \"aws-mcp.amazonaws.com\".", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Input structure for CreateOAuth2TokenWithIAM operation", "smithy.api#input": {} } }, "com.amazonaws.signin#CreateOAuth2TokenWithIAMResponse": { "type": "structure", "members": { "accessToken": { "target": "com.amazonaws.signin#OAuthAccessToken", "traits": { "smithy.api#documentation": "The access token containing principal identity, resource scope, and session metadata.", "smithy.api#jsonName": "access_token", "smithy.api#required": {} } }, "tokenType": { "target": "com.amazonaws.signin#BearerTokenType", "traits": { "smithy.api#documentation": "The token type. Always \"Bearer\" as defined in RFC 6749.", "smithy.api#jsonName": "token_type", "smithy.api#required": {} } }, "expiresIn": { "target": "com.amazonaws.signin#TokenExpiresIn", "traits": { "smithy.api#documentation": "The token lifetime in seconds. Value is the minimum of the caller's session validity and 1 hour (3600 seconds).", "smithy.api#jsonName": "expires_in", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output structure for CreateOAuth2TokenWithIAM operation\n\nContains the access token, token type, and expiration as defined in RFC 6749 \u00a75.1.", "smithy.api#output": {} } }, "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchange": { "type": "operation", "input": { "target": "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchangeRequest" }, "output": { "target": "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchangeResponse" }, "errors": [ { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#InvalidGrantException" }, { "target": "com.amazonaws.signin#InvalidScopeException" }, { "target": "com.amazonaws.signin#ServiceUnavailableException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "CreateOAuth2Token", "documentation": "Exchange a supported token for an OAuth 2.0 access token scoped to a resource" }, "smithy.api#auth": [], "smithy.api#documentation": "Exchanges a supported token for an OAuth 2.0 access token scoped to a resource, which you can use to access AWS services from applications.", "smithy.api#http": { "method": "POST", "uri": "/v1/token?x-amz-oauth-token-method=token-exchange" }, "smithy.rules#staticContextParams": { "IsOAuthEndpoint": { "value": true } } } }, "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchangeRequest": { "type": "structure", "members": { "grantType": { "target": "com.amazonaws.signin#TokenExchangeGrantType", "traits": { "smithy.api#documentation": "The OAuth 2.0 grant type. Currently supports \"urn:ietf:params:oauth:grant-type:token-exchange\"\nand \"urn:ietf:params:oauth:grant-type:jwt-bearer\".", "smithy.api#jsonName": "grant_type", "smithy.api#required": {} } }, "subjectToken": { "target": "com.amazonaws.signin#SubjectToken", "traits": { "smithy.api#documentation": "The subject token that represents the identity of the party on whose behalf the request is made.\nRequired when \"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\".", "smithy.api#jsonName": "subject_token" } }, "subjectTokenType": { "target": "com.amazonaws.signin#SubjectTokenType", "traits": { "smithy.api#documentation": "The token type of the subject token. Currently only supports \"urn:ietf:params:oauth:token-type:jwt\".\nRequired when \"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\".", "smithy.api#jsonName": "subject_token_type" } }, "assertion": { "target": "com.amazonaws.signin#Assertion", "traits": { "smithy.api#documentation": "The JWT authorization grant, as defined in RFC 7523.\nRequired when \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\"." } }, "clientId": { "target": "com.amazonaws.signin#JwtBearerClientId", "traits": { "smithy.api#documentation": "The OAuth 2.0 client identifier.\nIf provided with \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\", must match the assertion's \"client_id\" claim.", "smithy.api#jsonName": "client_id" } }, "resource": { "target": "com.amazonaws.signin#Resource", "traits": { "smithy.api#documentation": "The OAuth resource for which the access token is requested:\n\n- \"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\": Required. Must be a service principal. Example: \"glue.amazonaws.com\".\n- \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\": Required when the assertion has no \"resource\" claim, otherwise must match it. Must be a URI. Example: \"https://aws-mcp.us-east-1.api.aws/mcp\"." } }, "scope": { "target": "com.amazonaws.signin#Scope", "traits": { "smithy.api#documentation": "The IAM managed policy Amazon Resource Names (ARNs) to apply as session policies that further\nscope down the permissions of the issued access token, provided as a space-delimited list.\nExample: \"arn:aws:iam::444455556666:policy/MyPolicy\".\n\nIf provided with \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\", must match the assertion's \"scope\" claim." } } }, "traits": { "smithy.api#documentation": "Input structure for CreateOAuth2TokenWithTokenExchange operation", "smithy.api#input": {} } }, "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchangeResponse": { "type": "structure", "members": { "accessToken": { "target": "com.amazonaws.signin#OAuthAccessToken", "traits": { "smithy.api#documentation": "The access token containing principal identity, resource scope, and session metadata.", "smithy.api#jsonName": "access_token", "smithy.api#required": {} } }, "issuedTokenType": { "target": "com.amazonaws.signin#IssuedOAuthAccessTokenType", "traits": { "smithy.api#documentation": "The token type of the issued token. Returned when \"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\".\nValue is \"urn:ietf:params:oauth:token-type:access_token\" as defined in RFC 8693 \u00a72.2.1.", "smithy.api#jsonName": "issued_token_type" } }, "tokenType": { "target": "com.amazonaws.signin#BearerTokenType", "traits": { "smithy.api#documentation": "The token type. Currently only supports \"Bearer\" as defined in RFC 6749.", "smithy.api#jsonName": "token_type", "smithy.api#required": {} } }, "expiresIn": { "target": "com.amazonaws.signin#TokenExpiresIn", "traits": { "smithy.api#documentation": "The token lifetime in seconds. Value is the minimum of the provided token's validity and 1 hour (3600 seconds).", "smithy.api#jsonName": "expires_in", "smithy.api#required": {} } }, "resource": { "target": "com.amazonaws.signin#Resource", "traits": { "smithy.api#documentation": "The resource the access token is scoped to.\nReturned when \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\"." } }, "scope": { "target": "com.amazonaws.signin#Scope", "traits": { "smithy.api#documentation": "The IAM managed policy ARNs applied as session policies, as a space-delimited list.\nReturned when \"grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer\" and the assertion has a scope." } } }, "traits": { "smithy.api#documentation": "Output structure for CreateOAuth2TokenWithTokenExchange operation.\n\nContains the access token, token type, and expiration as defined in RFC 6749 \u00a75.1, plus fields specific to the grant type.", "smithy.api#output": {} } }, "com.amazonaws.signin#DeleteConsoleAuthorizationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.signin#DeleteConsoleAuthorizationConfigurationInput" }, "output": { "target": "com.amazonaws.signin#DeleteConsoleAuthorizationConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Delete console authorization configuration with automatic scope detection" }, "smithy.api#documentation": "Delete console authorization configuration with automatic scope detection", "smithy.api#http": { "method": "POST", "uri": "/delete-console-authorization-configuration" }, "smithy.api#idempotent": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#DeleteConsoleAuthorizationConfigurationInput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier" } } }, "traits": { "smithy.api#documentation": "Input for DeleteConsoleAuthorizationConfiguration operation", "smithy.api#input": {} } }, "com.amazonaws.signin#DeleteConsoleAuthorizationConfigurationOutput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier", "smithy.api#required": {} } }, "scope": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Authorization scope", "smithy.api#required": {} } }, "consoleAuthorizationEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether console authorization is enabled", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for DeleteConsoleAuthorizationConfiguration operation", "smithy.api#output": {} } }, "com.amazonaws.signin#DeleteResourcePermissionStatement": { "type": "operation", "input": { "target": "com.amazonaws.signin#DeleteResourcePermissionStatementInput" }, "output": { "target": "com.amazonaws.signin#DeleteResourcePermissionStatementOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Remove a permission statement from the account's SignIn resource-based policy" }, "smithy.api#documentation": "Remove a permission statement from the account's SignIn resource-based policy", "smithy.api#http": { "method": "POST", "uri": "/delete-resource-permission-statement" }, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#DeleteResourcePermissionStatementInput": { "type": "structure", "members": { "statementId": { "target": "com.amazonaws.signin#StatementId", "traits": { "smithy.api#documentation": "Unique identifier of the permission statement to delete", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.signin#ClientToken", "traits": { "smithy.api#documentation": "Idempotency token for the request", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#documentation": "Input for DeleteResourcePermissionStatement operation", "smithy.api#input": {} } }, "com.amazonaws.signin#DeleteResourcePermissionStatementOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Output for DeleteResourcePermissionStatement operation", "smithy.api#output": {} } }, "com.amazonaws.signin#ExcludedPrincipal": { "type": "string", "traits": { "smithy.api#documentation": "Principal to exclude from permission statements", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]+)*:((iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]{1,64})|(iam::[0-9]{12}:user/[a-zA-Z0-9_+=,.@-]{1,64})|(sts::[0-9]{12}:federated-user/[a-zA-Z0-9_+=,.@-]{2,193})|(iam::[0-9]{12}:root))$" } }, "com.amazonaws.signin#ExpiresIn": { "type": "integer", "traits": { "smithy.api#documentation": "Time to expiry in seconds. At most 900 (15 minutes).", "smithy.api#range": { "min": 1, "max": 900 } } }, "com.amazonaws.signin#GetConsoleAuthorizationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.signin#GetConsoleAuthorizationConfigurationInput" }, "output": { "target": "com.amazonaws.signin#GetConsoleAuthorizationConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Get console authorization configuration with automatic scope detection" }, "smithy.api#documentation": "Get console authorization configuration with automatic scope detection", "smithy.api#http": { "method": "POST", "uri": "/get-console-authorization-configuration" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#GetConsoleAuthorizationConfigurationInput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier" } } }, "traits": { "smithy.api#documentation": "Input for GetConsoleAuthorizationConfiguration operation", "smithy.api#input": {} } }, "com.amazonaws.signin#GetConsoleAuthorizationConfigurationOutput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier", "smithy.api#required": {} } }, "scope": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Authorization scope", "smithy.api#required": {} } }, "consoleAuthorizationEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether console authorization is enabled", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for GetConsoleAuthorizationConfiguration operation", "smithy.api#output": {} } }, "com.amazonaws.signin#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.signin#GetResourcePolicyInput" }, "output": { "target": "com.amazonaws.signin#GetResourcePolicyOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" } ], "traits": { "aws.iam#iamAction": { "documentation": "Retrieve the account's consolidated SignIn resource-based policy" }, "smithy.api#documentation": "Retrieve the account's consolidated SignIn resource-based policy", "smithy.api#http": { "method": "POST", "uri": "/get-resource-policy" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#GetResourcePolicyInput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Input for GetResourcePolicy operation", "smithy.api#input": {} } }, "com.amazonaws.signin#GetResourcePolicyOutput": { "type": "structure", "members": { "signinResourceBasedPolicy": { "target": "com.amazonaws.signin#SigninResourceBasedPolicy", "traits": { "smithy.api#documentation": "The account's SignIn resource-based policy", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for GetResourcePolicy operation", "smithy.api#output": {} } }, "com.amazonaws.signin#GetSession": { "type": "operation", "input": { "target": "com.amazonaws.signin#GetSessionInput" }, "output": { "target": "com.amazonaws.signin#GetSessionOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Retrieve the details of a single sign-in session" }, "smithy.api#documentation": "Returns the details of a single sign-in session. The session must belong to the identity specified by\nprincipalArn, or to the caller if principalArn is omitted. A session that belongs to a different identity or\naccount is reported as not found.", "smithy.api#examples": [ { "title": "Get one of your own sessions", "documentation": "Returns a session owned by the caller when principalArn is omitted.", "input": { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7" }, "output": { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7", "principalArn": "arn:aws:iam::123456789012:role/Developer", "role": "arn:aws:iam::123456789012:role/Developer", "status": "ACTIVE", "clientId": "arn:aws:signin:::devtools/same-device", "clientType": "CLI", "issuedAt": 1793825807, "expiresAt": 1794431207, "issuedInRegion": "us-east-1" } }, { "title": "Get another identity's session as an account administrator", "documentation": "Uses the account wildcard principal ARN to get a session owned by another IAM identity.", "input": { "principalArn": "arn:aws:iam::123456789012:*", "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/5dbdd43b-4135-4c59-ad06-5ddbcc2c1d77" }, "output": { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/5dbdd43b-4135-4c59-ad06-5ddbcc2c1d77", "principalArn": "arn:aws:iam::123456789012:role/ReadOnly", "role": "arn:aws:iam::123456789012:role/ReadOnly", "status": "ACTIVE", "clientId": "arn:aws:signin:::devtools/same-device", "clientType": "CLI", "issuedAt": 1793826107, "expiresAt": 1794431214, "issuedInRegion": "us-east-1" } } ], "smithy.api#http": { "method": "POST", "uri": "/get-session" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#GetSessionInput": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The ARN of the session to retrieve", "smithy.api#required": {} } }, "principalArn": { "target": "com.amazonaws.signin#PrincipalArnFilter", "traits": { "smithy.api#documentation": "The identity that owns the session. Omit to use the caller. Specify arn:aws:iam::{account-id}:* to retrieve\nany session in the account." } } }, "traits": { "smithy.api#documentation": "Input for GetSession operation", "smithy.api#input": {} } }, "com.amazonaws.signin#GetSessionOutput": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The session ARN", "smithy.api#required": {} } }, "principalArn": { "target": "com.amazonaws.signin#PrincipalArn", "traits": { "smithy.api#documentation": "The IAM identity that owns the session", "smithy.api#required": {} } }, "role": { "target": "com.amazonaws.signin#PrincipalArn", "traits": { "smithy.api#documentation": "The IAM role for the session, when the owner is a role" } }, "status": { "target": "com.amazonaws.signin#SessionStatus", "traits": { "smithy.api#documentation": "The session status" } }, "clientId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The OAuth client that created the session" } }, "clientType": { "target": "com.amazonaws.signin#ClientType", "traits": { "smithy.api#documentation": "The type of OAuth client that created the session" } }, "resource": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The resource that the session's tokens are bound to" } }, "issuedAt": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time the session was created, in Unix epoch seconds", "smithy.api#required": {} } }, "expiresAt": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time the session expires, in Unix epoch seconds", "smithy.api#required": {} } }, "lastUsedAt": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time the session was last refreshed, in Unix epoch seconds" } }, "issuedInRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The AWS Region where the session was created" } }, "originSessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The ARN of the session this session originated from" } }, "userAgent": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The user agent captured when the session was created or last refreshed" } } }, "traits": { "smithy.api#documentation": "Output for GetSession operation", "smithy.api#output": {} } }, "com.amazonaws.signin#GrantType": { "type": "string", "traits": { "smithy.api#documentation": "The OAuth 2.0 grant type. \"authorization_code\" for authorization code redemption, \"refresh_token\" for token refresh.", "smithy.api#pattern": "^(authorization_code|refresh_token)$" } }, "com.amazonaws.signin#IdToken": { "type": "string", "traits": { "smithy.api#documentation": "ID token (JWT) containing user identity claims. Returned only for authorization code redemption.", "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.signin#InternalServerException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "Will be server_error.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The server error detail.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because of an internal server error.", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.signin#IntrospectOAuth2TokenWithIAM": { "type": "operation", "input": { "target": "com.amazonaws.signin#IntrospectOAuth2TokenWithIAMRequest" }, "output": { "target": "com.amazonaws.signin#IntrospectOAuth2TokenWithIAMResponse" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "IntrospectOAuth2Token", "documentation": "Inspect the metadata of an AWS Sign-In OAuth 2.0 access_token or refresh_token" }, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "Inspects the metadata and active state of an OAuth 2.0 access token or refresh token.\n\nImplements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated\nendpoint. Returns the claims associated with a token issued by AWS Sign-In.", "smithy.api#http": { "method": "POST", "uri": "/v1/introspect?x-amz-client-auth-method=iam" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsOAuthEndpoint": { "value": true } } } }, "com.amazonaws.signin#IntrospectOAuth2TokenWithIAMRequest": { "type": "structure", "members": { "token": { "target": "com.amazonaws.signin#IntrospectionToken", "traits": { "smithy.api#documentation": "The access token or refresh token issued by AWS Sign-In.", "smithy.api#jsonName": "token", "smithy.api#required": {} } }, "tokenTypeHint": { "target": "com.amazonaws.signin#TokenTypeHint", "traits": { "smithy.api#documentation": "An optional hint about the type of the token submitted for introspection, as defined in RFC 7662 \u00a72.1.\nThe server checks both token types regardless of the hint. Allowed values: \"access_token\", \"refresh_token\".", "smithy.api#jsonName": "token_type_hint" } } }, "traits": { "smithy.api#documentation": "Input structure for IntrospectOAuth2TokenWithIAM operation\n\nRFC 7662 \u00a72.1 introspection request. Contains the token to inspect and an\noptional hint about the token's type.", "smithy.api#input": {} } }, "com.amazonaws.signin#IntrospectOAuth2TokenWithIAMResponse": { "type": "structure", "members": { "active": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the token is currently active. Returns \"true\" only when the token is valid,\nhas not expired, has not been revoked, and belongs to the caller's account.", "smithy.api#required": {} } }, "clientId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Client identifier for the OAuth 2.0 client that requested the token.", "smithy.api#jsonName": "client_id" } }, "userId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "User identifier matching the \"UserId\" field from \"sts:GetCallerIdentity\" for the token's subject principal.", "smithy.api#jsonName": "user_id" } }, "tokenType": { "target": "com.amazonaws.signin#IntrospectedTokenType", "traits": { "smithy.api#documentation": "Indicates which kind of token was introspected.\nOne of \"access_token\" or \"refresh_token\".", "smithy.api#jsonName": "token_type" } }, "exp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Token expiration time as a NumericDate (Unix epoch seconds).", "smithy.api#jsonName": "exp" } }, "iat": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Token issuance time as a NumericDate (Unix epoch seconds).", "smithy.api#jsonName": "iat" } }, "nbf": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Token \"not before\" time as a NumericDate (Unix epoch seconds).", "smithy.api#jsonName": "nbf" } }, "sub": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IAM principal Amazon Resource Name (ARN). For assumed-role sessions, this is the session ARN.", "smithy.api#jsonName": "sub" } }, "aud": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The OAuth resource the token is scoped to. Omitted for refresh tokens.\nExample: \"aws-mcp.amazonaws.com\".", "smithy.api#jsonName": "aud" } }, "iss": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Issuer of the token. Always \"signin.amazonaws.com\" for AWS Sign-In.", "smithy.api#jsonName": "iss" } }, "jti": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Unique identifier for the token.", "smithy.api#jsonName": "jti" } }, "accountId": { "target": "com.amazonaws.signin#AccountId", "traits": { "smithy.api#documentation": "12-digit AWS account ID of the token's subject principal.", "smithy.api#jsonName": "account_id" } }, "signinSession": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "AWS Sign-In session ARN bound to the token, of the form\narn:aws:signin:{region}:{account}:session/{uuid}.", "smithy.api#jsonName": "signin_session" } }, "resource": { "target": "com.amazonaws.signin#Resource", "traits": { "smithy.api#documentation": "The OAuth resource the token is scoped to. Only present for refresh token introspection.", "smithy.api#jsonName": "resource" } } }, "traits": { "smithy.api#documentation": "Output structure for IntrospectOAuth2TokenWithIAM operation\n\nRFC 7662 \u00a72.2 introspection response. Only `active` is required; all other\nclaims are omitted when the token is inactive.", "smithy.api#output": {} } }, "com.amazonaws.signin#IntrospectedTokenType": { "type": "string", "traits": { "smithy.api#documentation": "The token_type value in the introspection response.", "smithy.api#pattern": "^(access_token|refresh_token)$" } }, "com.amazonaws.signin#IntrospectionToken": { "type": "string", "traits": { "smithy.api#documentation": "Token string submitted for introspection. May be an AWS Sign-In access token or refresh token.", "smithy.api#length": { "min": 1, "max": 12288 }, "smithy.api#pattern": "^ASO[AR][A-Za-z0-9+/=_\\-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.signin#InvalidGrantException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "Will be invalid_grant.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because the provided grant is invalid or expired.", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.signin#InvalidScopeException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "Will be invalid_scope.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because the requested scope is invalid or exceeds the scope that can be granted.", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.signin#IssuedOAuthAccessTokenType": { "type": "string", "traits": { "smithy.api#pattern": "^urn:ietf:params:oauth:token-type:access_token$" } }, "com.amazonaws.signin#JwtBearerClientId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 212 } } }, "com.amazonaws.signin#ListResourcePermissionStatements": { "type": "operation", "input": { "target": "com.amazonaws.signin#ListResourcePermissionStatementsInput" }, "output": { "target": "com.amazonaws.signin#ListResourcePermissionStatementsOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Retrieve all permission statements in the account's SignIn resource-based policy" }, "smithy.api#documentation": "Retrieve all permission statements in the account's SignIn resource-based policy", "smithy.api#http": { "method": "POST", "uri": "/list-resource-permission-statements" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "permissionStatements" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#ListResourcePermissionStatementsInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.signin#ConsolePermissionMaxResults", "traits": { "smithy.api#documentation": "Maximum number of results to return" } }, "nextToken": { "target": "com.amazonaws.signin#NextToken", "traits": { "smithy.api#documentation": "Token for pagination" } } }, "traits": { "smithy.api#documentation": "Input for ListResourcePermissionStatements operation", "smithy.api#input": {} } }, "com.amazonaws.signin#ListResourcePermissionStatementsOutput": { "type": "structure", "members": { "permissionStatements": { "target": "com.amazonaws.signin#PermissionStatementSummaries", "traits": { "smithy.api#documentation": "List of permission statement summaries", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.signin#NextToken", "traits": { "smithy.api#documentation": "Token for next page of results" } } }, "traits": { "smithy.api#documentation": "Output for ListResourcePermissionStatements operation", "smithy.api#output": {} } }, "com.amazonaws.signin#ListSessions": { "type": "operation", "input": { "target": "com.amazonaws.signin#ListSessionsInput" }, "output": { "target": "com.amazonaws.signin#ListSessionsOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "List sign-in sessions for a target user or role" }, "smithy.api#documentation": "Lists sign-in sessions for an IAM identity in your account. If you omit principalArn, the operation lists the\ncaller's own sessions. Specify a user or role ARN to list that identity's sessions, or specify\narn:aws:iam::{account-id}:* to list all sessions in the account. Filters are combined with a logical AND.", "smithy.api#examples": [ { "title": "List your own sessions", "documentation": "Lists the caller's sessions when principalArn is omitted.", "input": {}, "output": { "items": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7", "principalArn": "arn:aws:iam::123456789012:role/Developer", "role": "arn:aws:iam::123456789012:role/Developer", "status": "ACTIVE", "issuedAt": 1793825807, "expiresAt": 1794431207, "clientId": "arn:aws:signin:::devtools/same-device", "clientType": "CLI" }, { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/4c63f231-2128-42cf-aa83-83589f9a0df2", "principalArn": "arn:aws:iam::123456789012:role/Developer", "role": "arn:aws:iam::123456789012:role/Developer", "status": "ACTIVE", "issuedAt": 1793824607, "expiresAt": 1794431212, "clientId": "arn:aws:signin:::devtools/same-device", "clientType": "CLI" } ] } }, { "title": "List active sessions one page at a time", "documentation": "Returns one active session and a token to request the next page.", "input": { "maxResults": 1, "status": "ACTIVE" }, "output": { "items": [ { "sessionArn": "arn:aws:signin:us-east-1:123456789012:session/3b0a6152-ba23-447d-83cf-b3b3cc7b95f7", "principalArn": "arn:aws:iam::123456789012:role/Developer", "role": "arn:aws:iam::123456789012:role/Developer", "status": "ACTIVE", "issuedAt": 1793825807, "expiresAt": 1794431207, "clientId": "arn:aws:signin:::devtools/same-device", "clientType": "CLI" } ], "nextToken": "AAMA-EXAMPLE-NEXT-TOKEN" } } ], "smithy.api#http": { "method": "POST", "uri": "/list-sessions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#ListSessionsInput": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.signin#PrincipalArnFilter", "traits": { "smithy.api#documentation": "The identity whose sessions to list. Omit to list the caller's own sessions. Specify\narn:aws:iam::{account-id}:* to list all sessions in the account." } }, "maxResults": { "target": "com.amazonaws.signin#SessionsMaxResults", "traits": { "smithy.api#documentation": "Maximum number of results to return" } }, "nextToken": { "target": "com.amazonaws.signin#NextToken", "traits": { "smithy.api#documentation": "Token for pagination" } }, "status": { "target": "com.amazonaws.signin#SessionStatus", "traits": { "smithy.api#documentation": "Returns only sessions with this status" } }, "clientId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Returns only sessions created by this OAuth client" } }, "issuedAfter": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Returns only sessions created at or after this time, in Unix epoch seconds" } }, "issuedBefore": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "Returns only sessions created before this time, in Unix epoch seconds" } } }, "traits": { "smithy.api#documentation": "Input for ListSessions operation", "smithy.api#input": {} } }, "com.amazonaws.signin#ListSessionsOutput": { "type": "structure", "members": { "items": { "target": "com.amazonaws.signin#SessionSummaryList", "traits": { "smithy.api#documentation": "List of session summaries", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.signin#NextToken", "traits": { "smithy.api#documentation": "Token for next page of results" } } }, "traits": { "smithy.api#documentation": "Output for ListSessions operation", "smithy.api#output": {} } }, "com.amazonaws.signin#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "Pagination token", "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^[-a-zA-Z0-9+=/_]*$" } }, "com.amazonaws.signin#OAuth2ErrorCode": { "type": "enum", "members": { "TOKEN_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Token has expired.", "smithy.api#enumValue": "TOKEN_EXPIRED" } }, "USER_CREDENTIALS_CHANGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "User credentials have been changed.", "smithy.api#enumValue": "USER_CREDENTIALS_CHANGED" } }, "INSUFFICIENT_PERMISSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Insufficient permissions to perform this operation.", "smithy.api#enumValue": "INSUFFICIENT_PERMISSIONS" } }, "AUTHCODE_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Authorization code has expired.", "smithy.api#enumValue": "AUTHCODE_EXPIRED" } }, "SERVER_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Internal server error occurred.", "smithy.api#enumValue": "server_error" } }, "INVALID_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request is missing a required parameter, includes an invalid parameter value, or is otherwise malformed.", "smithy.api#enumValue": "INVALID_REQUEST" } }, "RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Requested resource was not found.", "smithy.api#enumValue": "RESOURCE_NOT_FOUND" } }, "CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Request conflicts with the current state of the resource.", "smithy.api#enumValue": "CONFLICT" } }, "SERVICE_QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Request would cause a service quota to be exceeded.", "smithy.api#enumValue": "SERVICE_QUOTA_EXCEEDED" } }, "OAUTH_UNSUPPORTED_GRANT_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unsupported_grant_type" } }, "OAUTH_INVALID_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalid_request" } }, "OAUTH_INVALID_GRANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalid_grant" } }, "OAUTH_INVALID_SCOPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalid_scope" } }, "OAUTH_INVALID_TARGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalid_target" } }, "OAUTH_INVALID_CLIENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "invalid_client" } }, "OAUTH_RATE_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "rate_exceeded" } }, "OAUTH_SERVICE_UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "service_unavailable" } } }, "traits": { "smithy.api#documentation": "OAuth 2.0 error codes returned by the server\n\nStandard OAuth 2.0 error codes used in error responses to indicate\nthe specific type of error that occurred during token operations." } }, "com.amazonaws.signin#OAuthAccessToken": { "type": "string", "traits": { "smithy.api#documentation": "OAuth 2.0 access token containing principal identity and resource scope.", "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.signin#PermissionStatementSummaries": { "type": "list", "member": { "target": "com.amazonaws.signin#PermissionStatementSummary" } }, "com.amazonaws.signin#PermissionStatementSummary": { "type": "structure", "members": { "sid": { "target": "com.amazonaws.signin#StatementId", "traits": { "smithy.api#documentation": "Unique identifier for the permission statement", "smithy.api#required": {} } }, "condition": { "target": "com.amazonaws.signin#ConditionBlock", "traits": { "smithy.api#documentation": "Condition block for the permission statement" } } }, "traits": { "smithy.api#documentation": "Summary of a permission statement" } }, "com.amazonaws.signin#PolicyActions": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "List of policy actions" } }, "com.amazonaws.signin#PolicyStatement": { "type": "structure", "members": { "effect": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Effect of the policy statement (Allow/Deny)", "smithy.api#jsonName": "Effect" } }, "principal": { "target": "com.amazonaws.signin#Principal", "traits": { "smithy.api#documentation": "Principal the statement applies to", "smithy.api#jsonName": "Principal" } }, "action": { "target": "com.amazonaws.signin#PolicyActions", "traits": { "smithy.api#documentation": "Actions the statement controls", "smithy.api#jsonName": "Action" } }, "resource": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Resource the statement applies to", "smithy.api#jsonName": "Resource" } }, "condition": { "target": "com.amazonaws.signin#ConditionBlock", "traits": { "smithy.api#documentation": "Condition block for the statement", "smithy.api#jsonName": "Condition" } } }, "traits": { "smithy.api#documentation": "Individual policy statement within a resource-based policy" } }, "com.amazonaws.signin#PolicyStatements": { "type": "list", "member": { "target": "com.amazonaws.signin#PolicyStatement" } }, "com.amazonaws.signin#Principal": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "IAM principal identifier" } }, "com.amazonaws.signin#PrincipalArn": { "type": "string", "traits": { "smithy.api#documentation": "IAM identity that owns a session", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws:((iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]{1,64})|(iam::[0-9]{12}:user/[a-zA-Z0-9_+=,.@-]{1,64})|(sts::[0-9]{12}:federated-user/[a-zA-Z0-9_+=,.@-]{2,193})|(iam::[0-9]{12}:root))$" } }, "com.amazonaws.signin#PrincipalArnFilter": { "type": "string", "traits": { "smithy.api#documentation": "IAM identity ARN, or arn:aws:iam::{account-id}:* for all identities in the account", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws:((iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]{1,64})|(iam::[0-9]{12}:user/[a-zA-Z0-9_+=,.@-]{1,64})|(sts::[0-9]{12}:federated-user/[a-zA-Z0-9_+=,.@-]{2,193})|(iam::[0-9]{12}:root)|(iam::[0-9]{12}:[*]))$" } }, "com.amazonaws.signin#PutConsoleAuthorizationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.signin#PutConsoleAuthorizationConfigurationInput" }, "output": { "target": "com.amazonaws.signin#PutConsoleAuthorizationConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#ConflictException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ResourceNotFoundException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Enable console authorization configuration with automatic scope detection" }, "smithy.api#documentation": "Enable console authorization configuration with automatic scope detection", "smithy.api#http": { "method": "POST", "uri": "/put-console-authorization-configuration" }, "smithy.api#idempotent": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#PutConsoleAuthorizationConfigurationInput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier" } } }, "traits": { "smithy.api#documentation": "Input for PutConsoleAuthorizationConfiguration operation", "smithy.api#input": {} } }, "com.amazonaws.signin#PutConsoleAuthorizationConfigurationOutput": { "type": "structure", "members": { "targetId": { "target": "com.amazonaws.signin#TargetId", "traits": { "smithy.api#documentation": "Target account identifier", "smithy.api#required": {} } }, "scope": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Authorization scope", "smithy.api#required": {} } }, "consoleAuthorizationEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether console authorization is enabled", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for PutConsoleAuthorizationConfiguration operation", "smithy.api#output": {} } }, "com.amazonaws.signin#PutResourcePermissionStatement": { "type": "operation", "input": { "target": "com.amazonaws.signin#PutResourcePermissionStatementInput" }, "output": { "target": "com.amazonaws.signin#PutResourcePermissionStatementOutput" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#ConflictException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Create a permission statement in the account's SignIn resource-based policy" }, "smithy.api#documentation": "Create a permission statement in the account's SignIn resource-based policy", "smithy.api#http": { "method": "POST", "uri": "/put-resource-permission-statement" }, "smithy.api#idempotent": {}, "smithy.rules#staticContextParams": { "IsControlPlane": { "value": true } } } }, "com.amazonaws.signin#PutResourcePermissionStatementInput": { "type": "structure", "members": { "sourceVpc": { "target": "com.amazonaws.signin#SourceVpc", "traits": { "smithy.api#documentation": "VPC identifier to restrict console access" } }, "signinSourceVpce": { "target": "com.amazonaws.signin#SourceVpce", "traits": { "smithy.api#documentation": "SignIn VPC endpoint identifier" } }, "consoleSourceVpce": { "target": "com.amazonaws.signin#SourceVpce", "traits": { "smithy.api#documentation": "Console VPC endpoint identifier" } }, "vpcSourceIp": { "target": "com.amazonaws.signin#VpcSourceIp", "traits": { "smithy.api#documentation": "Source IP address within VPC" } }, "sourceIp": { "target": "com.amazonaws.signin#SourceIp", "traits": { "smithy.api#documentation": "Source IP address" } }, "requestedRegion": { "target": "com.amazonaws.signin#RequestedRegion", "traits": { "smithy.api#documentation": "AWS region where the VPC and VPC endpoint reside\nRequired when sourceVpc or signinSourceVpce/consoleSourceVpce is provided" } }, "excludedPrincipal": { "target": "com.amazonaws.signin#ExcludedPrincipal", "traits": { "smithy.api#documentation": "Principal to exclude from the permission statement" } }, "clientToken": { "target": "com.amazonaws.signin#ClientToken", "traits": { "smithy.api#documentation": "Idempotency token for the request", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#documentation": "Input for PutResourcePermissionStatement operation", "smithy.api#input": {} } }, "com.amazonaws.signin#PutResourcePermissionStatementOutput": { "type": "structure", "members": { "statementId": { "target": "com.amazonaws.signin#StatementId", "traits": { "smithy.api#documentation": "Unique identifier for the created permission statement", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Output for PutResourcePermissionStatement operation", "smithy.api#output": {} } }, "com.amazonaws.signin#RedirectUri": { "type": "string", "traits": { "smithy.api#documentation": "The redirect URI from the authorization request. Must match the original request exactly.", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.signin#RefreshToken": { "type": "string", "traits": { "smithy.api#documentation": "The refresh token returned from authorization code redemption. Used in subsequent token refresh requests.", "smithy.api#length": { "min": 1, "max": 12288 }, "smithy.api#sensitive": {} } }, "com.amazonaws.signin#RequestedRegion": { "type": "string", "traits": { "smithy.api#documentation": "AWS region identifier for VPC and VPC endpoint pairing", "smithy.api#pattern": "^[a-z]{2}(-[a-z]+)+-\\d+$" } }, "com.amazonaws.signin#Resource": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.signin#ResourceNotFoundException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "OAuth 2.0 error code indicating resource not found\nWill be RESOURCE_NOT_FOUND", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed message explaining which resource was not found\nProvides specific information about the missing resource", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Error thrown when requested resource is not found\n\nHTTP Status Code: 404 Not Found\n\nUsed when the specified resource does not exist", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.signin#RevocationReason": { "type": "string", "traits": { "smithy.api#documentation": "Reason for revoking a session", "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.signin#RevocationToken": { "type": "string", "traits": { "smithy.api#documentation": "Refresh token string submitted for revocation.", "smithy.api#length": { "min": 1, "max": 12288 }, "smithy.api#pattern": "^ASOR[A-Za-z0-9+/=_\\-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.signin#RevokeOAuth2TokenWithIAM": { "type": "operation", "input": { "target": "com.amazonaws.signin#RevokeOAuth2TokenWithIAMRequest" }, "output": { "target": "com.amazonaws.signin#RevokeOAuth2TokenWithIAMResponse" }, "errors": [ { "target": "com.amazonaws.signin#AccessDeniedException" }, { "target": "com.amazonaws.signin#InternalServerException" }, { "target": "com.amazonaws.signin#TooManyRequestsError" }, { "target": "com.amazonaws.signin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "name": "RevokeOAuth2Token", "documentation": "Revoke an AWS Sign-In OAuth 2.0 refresh_token and its associated token chain" }, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "Revokes an OAuth 2.0 refresh token and its associated token chain.", "smithy.api#http": { "method": "POST", "uri": "/v1/revoke?x-amz-client-auth-method=iam" }, "smithy.api#idempotent": {}, "smithy.rules#staticContextParams": { "IsOAuthEndpoint": { "value": true } } } }, "com.amazonaws.signin#RevokeOAuth2TokenWithIAMRequest": { "type": "structure", "members": { "token": { "target": "com.amazonaws.signin#RevocationToken", "traits": { "smithy.api#documentation": "The refresh token to revoke. Must be a refresh token issued by AWS Sign-In.\nAccess tokens are not accepted for revocation.", "smithy.api#jsonName": "token", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Input structure for RevokeOAuth2TokenWithIAM operation\n\nRFC 7009 \u00a72.1 revocation request. Contains the refresh_token to revoke.", "smithy.api#input": {} } }, "com.amazonaws.signin#RevokeOAuth2TokenWithIAMResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Output structure for RevokeOAuth2TokenWithIAM operation\n\nRFC 7009 \u00a72.2 revocation response. The endpoint returns 200 OK with an\nempty body on success; there are no response fields.", "smithy.api#output": {} } }, "com.amazonaws.signin#RevokedSession": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The revoked session ARN", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A session that was revoked" } }, "com.amazonaws.signin#RevokedSessionList": { "type": "list", "member": { "target": "com.amazonaws.signin#RevokedSession" } }, "com.amazonaws.signin#Scope": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.signin#ServiceQuotaExceededException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "OAuth 2.0 error code indicating service quota exceeded\nWill be SERVICE_QUOTA_EXCEEDED", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed message explaining which quota was exceeded\nProvides specific information about the limit and current usage", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Error thrown when service quota is exceeded\n\nHTTP Status Code: 402 Payment Required (used as quota exceeded indicator)\n\nUsed when the request would cause a service quota to be exceeded", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.signin#ServiceUnavailableException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "Will be service_unavailable.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because a dependency is temporarily unavailable. You can retry the request.", "smithy.api#error": "server", "smithy.api#httpError": 503, "smithy.api#retryable": {} } }, "com.amazonaws.signin#Session": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.signin#SessionArn", "traits": { "smithy.api#documentation": "The session ARN", "smithy.api#required": {} } }, "principalArn": { "target": "com.amazonaws.signin#PrincipalArn", "traits": { "smithy.api#documentation": "The IAM identity that owns the session", "smithy.api#required": {} } }, "role": { "target": "com.amazonaws.signin#PrincipalArn", "traits": { "smithy.api#documentation": "The IAM role for the session, when the owner is a role" } }, "status": { "target": "com.amazonaws.signin#SessionStatus", "traits": { "smithy.api#documentation": "The session status" } }, "issuedAt": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time the session was created, in Unix epoch seconds", "smithy.api#required": {} } }, "expiresAt": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time the session expires, in Unix epoch seconds", "smithy.api#required": {} } }, "clientId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The OAuth client that created the session" } }, "clientType": { "target": "com.amazonaws.signin#ClientType", "traits": { "smithy.api#documentation": "The type of OAuth client that created the session" } }, "resource": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The resource that the session's tokens are bound to" } } }, "traits": { "smithy.api#documentation": "Summary of a sign-in session" } }, "com.amazonaws.signin#SessionArn": { "type": "string", "traits": { "smithy.api#documentation": "Sign-in session ARN", "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.signin#SessionArnList": { "type": "list", "member": { "target": "com.amazonaws.signin#SessionArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.signin#SessionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The session is active", "smithy.api#enumValue": "ACTIVE" } }, "REVOKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The session has been revoked", "smithy.api#enumValue": "REVOKED" } } }, "traits": { "smithy.api#documentation": "Status of a sign-in session" } }, "com.amazonaws.signin#SessionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.signin#Session" } }, "com.amazonaws.signin#SessionsMaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "Maximum number of sessions to return", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.signin#Signin": { "type": "service", "version": "2023-01-01", "operations": [ { "target": "com.amazonaws.signin#BatchRevokeSessions" }, { "target": "com.amazonaws.signin#CreateBearerToken" }, { "target": "com.amazonaws.signin#CreateOAuth2Token" }, { "target": "com.amazonaws.signin#CreateOAuth2TokenWithIAM" }, { "target": "com.amazonaws.signin#CreateOAuth2TokenWithTokenExchange" }, { "target": "com.amazonaws.signin#DeleteConsoleAuthorizationConfiguration" }, { "target": "com.amazonaws.signin#DeleteResourcePermissionStatement" }, { "target": "com.amazonaws.signin#GetConsoleAuthorizationConfiguration" }, { "target": "com.amazonaws.signin#GetResourcePolicy" }, { "target": "com.amazonaws.signin#GetSession" }, { "target": "com.amazonaws.signin#IntrospectOAuth2TokenWithIAM" }, { "target": "com.amazonaws.signin#ListResourcePermissionStatements" }, { "target": "com.amazonaws.signin#ListSessions" }, { "target": "com.amazonaws.signin#PutConsoleAuthorizationConfiguration" }, { "target": "com.amazonaws.signin#PutResourcePermissionStatement" }, { "target": "com.amazonaws.signin#RevokeOAuth2TokenWithIAM" } ], "traits": { "aws.api#service": { "sdkId": "Signin", "arnNamespace": "signin", "endpointPrefix": "signin" }, "aws.auth#sigv4": { "name": "signin" }, "aws.endpoints#rulesBasedEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": { "partitionSpecialCases": { "aws": [ { "endpoint": "https://{region}.signin.aws.amazon.com" } ], "aws-cn": [ { "endpoint": "https://{region}.signin.amazonaws.cn" } ], "aws-us-gov": [ { "endpoint": "https://{region}.signin.amazonaws-us-gov.com" } ] } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "AWS Sign-In manages authentication for AWS services. It implements OAuth 2.0, providing secure token exchange and refresh capabilities.", "smithy.api#title": "AWS Sign-In Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "IsControlPlane": { "required": false, "documentation": "Indicates if the operation targets the control plane endpoint", "type": "boolean" }, "IsOAuthEndpoint": { "required": false, "documentation": "Indicates if the operation targets the OAuth token endpoint", "type": "boolean" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "booleanEquals", "argv": [ { "fn": "coalesce", "argv": [ { "ref": "IsControlPlane" }, false ] }, true ] }, { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "coalesce", "argv": [ { "ref": "IsOAuthEndpoint" }, false ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-west-1" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "endpoint": { "url": "https://signin.{Region}.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.api.amazonwebservices.com.cn", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{Region}.oauth.signin.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.aws.amazon.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.amazonaws.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.c2shome.ic.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.sc2shome.sgov.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.csphome.hci.ic.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.csphome.adc-e.uk", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.amazonaws-eusc.eu", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signin-fips.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin-fips.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{Region}.signin.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 40, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAgAAACQAAAAEAAAABAAAAAUF9eEbAAAABgX14QQF9eEbAAAAAQAAAB0AAAAHAAAAAgAAACQAAAAIAAAAAwAAAAkAAAAfAAAABAAAABYAAAAKAAAABQAAABMAAAALAAAABwAAABUAAAAMAAAACAX14QcAAAANAAAACgX14QgAAAAOAAAADAX14QkAAAAPAAAADQX14QoAAAAQAAAADgX14QsAAAARAAAADwX14QwAAAASAAAAEAX14Q0F9eEQAAAABgX14QUAAAAUAAAABwAAABUF9eEGAAAAEQX14RgF9eEZAAAABgX14QQAAAAXAAAABwAAABsAAAAYAAAACQX14Q4AAAAZAAAACgX14Q8AAAAaAAAACwX14RYF9eEXAAAACwAAABwF9eEVAAAAEQX14RQF9eEVAAAAAgAAACMAAAAeAAAAAwAAACcAAAAfAAAABAAAACAF9eEbAAAABgX14QQAAAAhAAAABwX14RsAAAAiAAAACQX14Q4F9eEbAAAAAwAAACcAAAAkAAAABAAAACYAAAAlAAAABwX14RIF9eETAAAABgX14QQF9eERAAAABQX14QEAAAAoAAAACAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "IsControlPlane": { "required": false, "documentation": "Indicates if the operation targets the control plane endpoint", "type": "boolean" }, "IsOAuthEndpoint": { "required": false, "documentation": "Indicates if the operation targets the OAuth token endpoint", "type": "boolean" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "IsControlPlane" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "IsControlPlane" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "endpoint": { "url": "https://signin.{Region}.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] } ], "endpoint": { "url": "https://signin.{Region}.api.amazonwebservices.com.cn", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "IsOAuthEndpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "IsOAuthEndpoint" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "IsOAuthEndpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "IsOAuthEndpoint" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "endpoint": { "url": "https://{Region}.oauth.signin.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "endpoint": { "url": "https://{Region}.signin.aws.amazon.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] } ], "endpoint": { "url": "https://{Region}.signin.amazonaws.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://{Region}.signin.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ], "endpoint": { "url": "https://{Region}.signin.c2shome.ic.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ], "endpoint": { "url": "https://{Region}.signin.sc2shome.sgov.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] } ], "endpoint": { "url": "https://{Region}.signin.csphome.hci.ic.gov", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] } ], "endpoint": { "url": "https://{Region}.signin.csphome.adc-e.uk", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] } ], "endpoint": { "url": "https://{Region}.signin.amazonaws-eusc.eu", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-west-1" ] } ], "endpoint": { "url": "https://signin-fips.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://{Region}.signin-fips.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "endpoint": { "url": "https://{Region}.signin.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://{Region}.signin.aws.amazon.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://{Region}.signin.amazonaws.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://{Region}.signin.amazonaws-us-gov.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://signin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "Control Plane operation in us-east-1 (aws partition)", "expect": { "endpoint": { "url": "https://signin.us-east-1.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "us-east-1" } ] } } }, "params": { "IsControlPlane": true, "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Control Plane operation in cn-north-1 (aws-cn partition)", "expect": { "endpoint": { "url": "https://signin.cn-north-1.api.amazonwebservices.com.cn", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "cn-north-1" } ] } } }, "params": { "IsControlPlane": true, "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Data Plane operation in us-east-1", "expect": { "endpoint": { "url": "https://us-east-1.signin.aws.amazon.com" } }, "params": { "IsControlPlane": false, "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Data Plane operation in us-east-1 (IsControlPlane not set)", "expect": { "endpoint": { "url": "https://us-east-1.signin.aws.amazon.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Data Plane operation in cn-north-1", "expect": { "endpoint": { "url": "https://cn-north-1.signin.amazonaws.cn" } }, "params": { "IsControlPlane": false, "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Data Plane operation in us-gov-west-1", "expect": { "endpoint": { "url": "https://us-gov-west-1.signin.amazonaws-us-gov.com" } }, "params": { "IsControlPlane": false, "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "FIPS endpoint in us-gov-west-1 (global endpoint)", "expect": { "endpoint": { "url": "https://signin-fips.amazonaws-us-gov.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "FIPS endpoint in us-gov-east-1 (regional endpoint)", "expect": { "endpoint": { "url": "https://us-gov-east-1.signin-fips.amazonaws-us-gov.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "FIPS endpoint in us-east-1", "expect": { "endpoint": { "url": "https://signin-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "DualStack falls through to default SDK endpoint in us-east-1 (aws partition)", "expect": { "endpoint": { "url": "https://signin.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "DualStack falls through to default SDK endpoint in cn-north-1 (aws-cn partition)", "expect": { "endpoint": { "url": "https://signin.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "DualStack falls through to default SDK endpoint in us-gov-west-1 (aws-us-gov partition)", "expect": { "endpoint": { "url": "https://signin.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "Custom SDK endpoint override", "expect": { "endpoint": { "url": "https://custom.signin.example.com" } }, "params": { "Region": "us-east-1", "Endpoint": "https://custom.signin.example.com", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "ISO partition (us-iso-east-1)", "expect": { "endpoint": { "url": "https://us-iso-east-1.signin.c2shome.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "ISO-B partition (us-isob-east-1)", "expect": { "endpoint": { "url": "https://us-isob-east-1.signin.sc2shome.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "OAuth endpoint in us-east-1 (aws partition)", "expect": { "endpoint": { "url": "https://us-east-1.oauth.signin.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "us-east-1" } ] } } }, "params": { "IsOAuthEndpoint": true, "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "OAuth endpoint in us-west-2 (aws partition)", "expect": { "endpoint": { "url": "https://us-west-2.oauth.signin.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "signin", "signingRegion": "us-west-2" } ] } } }, "params": { "IsOAuthEndpoint": true, "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "OAuth endpoint with FIPS returns an error (no FIPS variant exists)", "expect": { "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation." }, "params": { "IsOAuthEndpoint": true, "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "OAuth endpoint with FIPS returns an error in us-west-2 (aws partition)", "expect": { "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation." }, "params": { "IsOAuthEndpoint": true, "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "OAuth endpoint with FIPS returns an error in cn-north-1 (non-aws partition, error is partition-agnostic)", "expect": { "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation." }, "params": { "IsOAuthEndpoint": true, "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "OAuth endpoint with FIPS returns an error even with a custom SDK endpoint override", "expect": { "error": "FIPS endpoints are not supported for OAuth operations. Disable FIPS or use a non-OAuth operation." }, "params": { "IsOAuthEndpoint": true, "Region": "us-east-1", "Endpoint": "https://custom.signin.example.com", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "OAuth operation with custom SDK endpoint override", "expect": { "endpoint": { "url": "https://custom.signin.example.com" } }, "params": { "IsOAuthEndpoint": true, "Region": "us-east-1", "Endpoint": "https://custom.signin.example.com", "UseFIPS": false, "UseDualStack": false } } ], "version": "1.0" } } }, "com.amazonaws.signin#SigninResourceBasedPolicy": { "type": "structure", "members": { "version": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Policy version", "smithy.api#jsonName": "Version" } }, "statement": { "target": "com.amazonaws.signin#PolicyStatements", "traits": { "smithy.api#documentation": "Policy statements", "smithy.api#jsonName": "Statement" } } }, "traits": { "smithy.api#documentation": "SignIn resource-based policy document" } }, "com.amazonaws.signin#SourceIp": { "type": "string", "traits": { "smithy.api#documentation": "Source IP address for access control" } }, "com.amazonaws.signin#SourceVpc": { "type": "string", "traits": { "smithy.api#documentation": "VPC identifier for network-based access control", "smithy.api#pattern": "^vpc-([0-9a-f]{8}|[0-9a-f]{17})$" } }, "com.amazonaws.signin#SourceVpce": { "type": "string", "traits": { "smithy.api#documentation": "VPC endpoint identifier", "smithy.api#pattern": "^vpce-[a-z0-9]{8,20}$" } }, "com.amazonaws.signin#StatementId": { "type": "string", "traits": { "smithy.api#documentation": "Unique identifier for a permission statement", "smithy.api#pattern": "^[A-Za-z0-9+/]{64}=?$" } }, "com.amazonaws.signin#SubjectToken": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 20000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.signin#SubjectTokenType": { "type": "string", "traits": { "smithy.api#pattern": "^urn:ietf:params:oauth:token-type:.+$" } }, "com.amazonaws.signin#TargetId": { "type": "string", "traits": { "smithy.api#documentation": "Target account identifier for console authorization", "smithy.api#length": { "min": 12, "max": 32 }, "smithy.api#pattern": "^(\\d{12}|o-[a-z0-9]{10}|r-[0-9a-z]{4,32})$" } }, "com.amazonaws.signin#TokenDuration": { "type": "integer", "traits": { "smithy.api#documentation": "Requested token lifetime in seconds, at least 300 (5 minutes).", "smithy.api#range": { "min": 300 } } }, "com.amazonaws.signin#TokenExchangeGrantType": { "type": "string", "traits": { "smithy.api#pattern": "^urn:ietf:params:oauth:grant-type:(token-exchange|jwt-bearer)$" } }, "com.amazonaws.signin#TokenExpiresIn": { "type": "integer", "traits": { "smithy.api#documentation": "Token lifetime in seconds. The lesser of session validity and 3600 (1 hour).", "smithy.api#range": { "min": 1, "max": 3600 } } }, "com.amazonaws.signin#TokenType": { "type": "string", "traits": { "smithy.api#documentation": "The token type. \"aws_sigv4\" indicates the client must use the token to generate a SigV4 signature.", "smithy.api#pattern": "^aws_sigv4$" } }, "com.amazonaws.signin#TokenTypeHint": { "type": "string", "traits": { "smithy.api#documentation": "Optional token_type_hint value, as defined in RFC 7662 \u00a72.1. One of \"access_token\" or \"refresh_token\".", "smithy.api#pattern": "^(access_token|refresh_token)$" } }, "com.amazonaws.signin#TooManyRequestsError": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "Will be rate_exceeded.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Details about the rate limit.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because you exceeded the request rate limit for this operation.", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.signin#ValidationException": { "type": "structure", "members": { "error": { "target": "com.amazonaws.signin#OAuth2ErrorCode", "traits": { "smithy.api#documentation": "The specific code depends on which validation failed.", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The validation constraint that failed.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request failed because it contains a malformed, missing, or invalid parameter.", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.signin#VpcSourceIp": { "type": "string", "traits": { "smithy.api#documentation": "Source IP address within a VPC" } } } }