Cancels an approval session. For more information, see Session in the Multi-party approval User Guide.
", "idempotent":true }, "CreateApprovalTeam":{ "name":"CreateApprovalTeam", "http":{ "method":"POST", "requestUri":"/approval-teams", "responseCode":200 }, "input":{"shape":"CreateApprovalTeamRequest"}, "output":{"shape":"CreateApprovalTeamResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Creates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.
", "idempotent":true }, "CreateIdentitySource":{ "name":"CreateIdentitySource", "http":{ "method":"POST", "requestUri":"/identity-sources", "responseCode":200 }, "input":{"shape":"CreateIdentitySourceRequest"}, "output":{"shape":"CreateIdentitySourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.
", "idempotent":true }, "DeleteIdentitySource":{ "name":"DeleteIdentitySource", "http":{ "method":"DELETE", "requestUri":"/identity-sources/{IdentitySourceArn}", "responseCode":200 }, "input":{"shape":"DeleteIdentitySourceRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Deletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
", "idempotent":true }, "DeleteInactiveApprovalTeamVersion":{ "name":"DeleteInactiveApprovalTeamVersion", "http":{ "method":"DELETE", "requestUri":"/approval-teams/{Arn}/{VersionId}", "responseCode":200 }, "input":{"shape":"DeleteInactiveApprovalTeamVersionRequest"}, "output":{"shape":"DeleteInactiveApprovalTeamVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Deletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide.
You can also use this operation to delete a team draft. For more information, see Interacting with drafts in the Multi-party approval User Guide.
", "idempotent":true }, "GetApprovalTeam":{ "name":"GetApprovalTeam", "http":{ "method":"GET", "requestUri":"/approval-teams/{Arn}", "responseCode":200 }, "input":{"shape":"GetApprovalTeamRequest"}, "output":{"shape":"GetApprovalTeamResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns details for an approval team.
", "readonly":true }, "GetIdentitySource":{ "name":"GetIdentitySource", "http":{ "method":"GET", "requestUri":"/identity-sources/{IdentitySourceArn}", "responseCode":200 }, "input":{"shape":"GetIdentitySourceRequest"}, "output":{"shape":"GetIdentitySourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Returns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.
", "readonly":true }, "GetPolicyVersion":{ "name":"GetPolicyVersion", "http":{ "method":"GET", "requestUri":"/policy-versions/{PolicyVersionArn}", "responseCode":200 }, "input":{"shape":"GetPolicyVersionRequest"}, "output":{"shape":"GetPolicyVersionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Returns details for the version of a policy. Policies define the permissions for team resources.
", "readonly":true }, "GetResourcePolicy":{ "name":"GetResourcePolicy", "http":{ "method":"POST", "requestUri":"/GetResourcePolicy", "responseCode":200 }, "input":{"shape":"GetResourcePolicyRequest"}, "output":{"shape":"GetResourcePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns details about a policy for a resource.
", "readonly":true }, "GetSession":{ "name":"GetSession", "http":{ "method":"GET", "requestUri":"/sessions/{SessionArn}", "responseCode":200 }, "input":{"shape":"GetSessionRequest"}, "output":{"shape":"GetSessionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns details for an approval session. For more information, see Session in the Multi-party approval User Guide.
", "readonly":true }, "ListApprovalTeams":{ "name":"ListApprovalTeams", "http":{ "method":"POST", "requestUri":"/approval-teams/?List", "responseCode":200 }, "input":{"shape":"ListApprovalTeamsRequest"}, "output":{"shape":"ListApprovalTeamsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of approval teams.
", "readonly":true }, "ListIdentitySources":{ "name":"ListIdentitySources", "http":{ "method":"POST", "requestUri":"/identity-sources/?List", "responseCode":200 }, "input":{"shape":"ListIdentitySourcesRequest"}, "output":{"shape":"ListIdentitySourcesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.
", "readonly":true }, "ListPolicies":{ "name":"ListPolicies", "http":{ "method":"POST", "requestUri":"/policies/?List", "responseCode":200 }, "input":{"shape":"ListPoliciesRequest"}, "output":{"shape":"ListPoliciesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of policies. Policies define the permissions for team resources.
", "readonly":true }, "ListPolicyVersions":{ "name":"ListPolicyVersions", "http":{ "method":"POST", "requestUri":"/policies/{PolicyArn}/?List", "responseCode":200 }, "input":{"shape":"ListPolicyVersionsRequest"}, "output":{"shape":"ListPolicyVersionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of the versions for policies. Policies define the permissions for team resources.
", "readonly":true }, "ListResourcePolicies":{ "name":"ListResourcePolicies", "http":{ "method":"POST", "requestUri":"/resource-policies/{ResourceArn}/?List", "responseCode":200 }, "input":{"shape":"ListResourcePoliciesRequest"}, "output":{"shape":"ListResourcePoliciesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of policies for a resource.
", "readonly":true }, "ListSessions":{ "name":"ListSessions", "http":{ "method":"POST", "requestUri":"/approval-teams/{ApprovalTeamArn}/sessions/?List", "responseCode":200 }, "input":{"shape":"ListSessionsRequest"}, "output":{"shape":"ListSessionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of the tags for a resource.
", "readonly":true }, "StartActiveApprovalTeamDeletion":{ "name":"StartActiveApprovalTeamDeletion", "http":{ "method":"POST", "requestUri":"/approval-teams/{Arn}?Delete", "responseCode":200 }, "input":{"shape":"StartActiveApprovalTeamDeletionRequest"}, "output":{"shape":"StartActiveApprovalTeamDeletionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Starts the deletion process for an active approval team.
Deletions require team approval
Requests to delete an active team must be approved by the team.
Starts a baseline session for specified approvers on an ACTIVE approval team.
Creates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Removes a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
", "idempotent":true }, "UpdateApprovalTeam":{ "name":"UpdateApprovalTeam", "http":{ "method":"PATCH", "requestUri":"/approval-teams/{Arn}", "responseCode":200 }, "input":{"shape":"UpdateApprovalTeamRequest"}, "output":{"shape":"UpdateApprovalTeamResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Updates an approval team. You can request to update the team description, approval threshold, and approvers in the team.
Updates require team approval
Updates to an active team must be approved by the team.
Message for the AccessDeniedException error.
You do not have sufficient access to perform this action. Check your permissions, and try again.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccountId":{ "type":"string", "max":12, "min":0, "pattern":"\\d{12}" }, "ActionCompletionStrategy":{ "type":"string", "enum":["AUTO_COMPLETION_UPON_APPROVAL"] }, "ActionName":{ "type":"string", "max":500, "min":0 }, "AdditionalSecurityRequirement":{ "type":"string", "documentation":"Additional security requirements applied to a session or invitation
APPROVER_VERIFICATION_REQUIRED: Approvers will be required to perform an MFA challenge to vote
Minimum number of approvals (M) required for a total number of approvers (N).
" } }, "documentation":"Strategy for how an approval team grants approval.
", "union":true }, "ApprovalStrategyResponse":{ "type":"structure", "members":{ "MofN":{ "shape":"MofNApprovalStrategy", "documentation":"Minimum number of approvals (M) required for a total number of approvers (N).
" } }, "documentation":"Contains details for how an approval team grants approval.
", "union":true }, "ApprovalTeamArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:mpa:[a-z0-9-]{1,20}:[0-9]{12}:approval-team/[a-zA-Z0-9._-]+" }, "ApprovalTeamName":{ "type":"string", "max":64, "min":0, "pattern":"[a-zA-Z0-9._-]+" }, "ApprovalTeamRequestApprover":{ "type":"structure", "required":[ "PrimaryIdentityId", "PrimaryIdentitySourceArn" ], "members":{ "PrimaryIdentityId":{ "shape":"IdentityId", "documentation":"ID for the user.
" }, "PrimaryIdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.
" } }, "documentation":"Contains details for an approver.
" }, "ApprovalTeamRequestApprovers":{ "type":"list", "member":{"shape":"ApprovalTeamRequestApprover"}, "max":20, "min":1 }, "ApprovalTeamStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "DELETING", "PENDING" ] }, "ApprovalTeamStatusCode":{ "type":"string", "enum":[ "VALIDATING", "PENDING_ACTIVATION", "FAILED_VALIDATION", "FAILED_ACTIVATION", "UPDATE_PENDING_APPROVAL", "UPDATE_PENDING_ACTIVATION", "UPDATE_FAILED_APPROVAL", "UPDATE_FAILED_ACTIVATION", "UPDATE_FAILED_VALIDATION", "DELETE_PENDING_APPROVAL", "DELETE_FAILED_APPROVAL", "DELETE_FAILED_VALIDATION" ] }, "ApproverLastActivity":{ "type":"string", "enum":[ "VOTED", "BASELINED", "RESPONDED_TO_INVITATION" ] }, "Boolean":{ "type":"boolean", "box":true }, "CancelSessionRequest":{ "type":"structure", "required":["SessionArn"], "members":{ "SessionArn":{ "shape":"SessionArn", "documentation":"Amazon Resource Name (ARN) for the session.
", "location":"uri", "locationName":"SessionArn" } } }, "CancelSessionResponse":{ "type":"structure", "members":{} }, "ConflictException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the ConflictException error.
The request cannot be completed because it conflicts with the current state of a resource.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateApprovalTeamRequest":{ "type":"structure", "required":[ "ApprovalStrategy", "Approvers", "Description", "Policies", "Name" ], "members":{ "ClientToken":{ "shape":"Token", "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.
What is idempotency?
When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
An ApprovalStrategy object. Contains details for how the team grants approval.
An array of ApprovalTeamRequesterApprovers objects. Contains details for the approvers in the team.
Description for the team.
" }, "Policies":{ "shape":"PoliciesReferences", "documentation":"An array of PolicyReference objects. Contains a list of policies that define the permissions for team resources.
Name of the team.
" }, "Tags":{ "shape":"Tags", "documentation":"Tags you want to attach to the team.
" } } }, "CreateApprovalTeamResponse":{ "type":"structure", "members":{ "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the team was created.
" }, "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the team that was created.
" }, "Name":{ "shape":"String", "documentation":"Name of the team that was created.
" }, "VersionId":{ "shape":"String", "documentation":"Version ID for the team that was created. When a team is updated, the version ID changes.
" } } }, "CreateIdentitySourceRequest":{ "type":"structure", "required":["IdentitySourceParameters"], "members":{ "IdentitySourceParameters":{ "shape":"IdentitySourceParameters", "documentation":"A IdentitySourceParameters object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.
What is idempotency?
When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
Tag you want to attach to the identity source.
" } } }, "CreateIdentitySourceResponse":{ "type":"structure", "members":{ "IdentitySourceType":{ "shape":"IdentitySourceType", "documentation":"The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance.
" }, "IdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the identity source that was created.
" }, "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the identity source was created.
" } } }, "DeleteIdentitySourceRequest":{ "type":"structure", "required":["IdentitySourceArn"], "members":{ "IdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for identity source.
", "location":"uri", "locationName":"IdentitySourceArn" } } }, "DeleteInactiveApprovalTeamVersionRequest":{ "type":"structure", "required":[ "Arn", "VersionId" ], "members":{ "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amaazon Resource Name (ARN) for the team.
", "location":"uri", "locationName":"Arn" }, "VersionId":{ "shape":"String", "documentation":"Version ID for the team.
", "location":"uri", "locationName":"VersionId" } } }, "DeleteInactiveApprovalTeamVersionResponse":{ "type":"structure", "members":{} }, "Description":{ "type":"string", "max":256, "min":1, "sensitive":true }, "Filter":{ "type":"structure", "members":{ "FieldName":{ "shape":"FilterField", "documentation":"Name of the filter to use.
Supported filters
The supported filters for ListSessions are: ActionName, SessionStatus, and InitationTime.
Operator to use for filtering.
EQ: Equal to the specified value
NE: Not equal to the specified value
GT: Greater than the specified value
LT: Less than the specified value
GTE: Greater than or equal to the specified value
LTE: Less than or equal to the specified value
CONTAINS: Contains the specified value
NOT_CONTAINS: Does not contain the specified value
BETWEEN: Between two values, inclusive of the specified values.
Supported operators for each filter:
ActionName: EQ | NE | CONTAINS | NOT_CONTAINS
SessionStatus: EQ | NE
InitiationTime: GT | LT | GTE | LTE | BETWEEN
Value to use for filtering. For the BETWEEN operator, specify values in the format a AND b (AND is case-insensitive).
Contains the filter to apply to requests. You can specify up to 10 filters for a request.
" }, "FilterField":{ "type":"string", "enum":[ "ActionName", "ApprovalTeamName", "VotingTime", "Vote", "SessionStatus", "InitiationTime" ] }, "Filters":{ "type":"list", "member":{"shape":"Filter"}, "max":10, "min":0 }, "GetApprovalTeamRequest":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the team.
", "location":"uri", "locationName":"Arn" } } }, "GetApprovalTeamResponse":{ "type":"structure", "members":{ "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the team was created.
" }, "ApprovalStrategy":{ "shape":"ApprovalStrategyResponse", "documentation":"An ApprovalStrategyResponse object. Contains details for how the team grants approval.
Total number of approvers in the team.
" }, "Approvers":{ "shape":"GetApprovalTeamResponseApprovers", "documentation":"An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.
Amazon Resource Name (ARN) for the team.
" }, "Description":{ "shape":"Description", "documentation":"Description for the team.
" }, "Name":{ "shape":"String", "documentation":"Name of the approval team.
" }, "Status":{ "shape":"ApprovalTeamStatus", "documentation":"Status for the team. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusCode":{ "shape":"ApprovalTeamStatusCode", "documentation":"Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusMessage":{ "shape":"Message", "documentation":"Message describing the status for the team.
" }, "UpdateSessionArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the session.
" }, "VersionId":{ "shape":"String", "documentation":"Version ID for the team.
" }, "Policies":{ "shape":"PoliciesReferences", "documentation":"An array of PolicyReference objects. Contains a list of policies that define the permissions for team resources.
Timestamp when the team was last updated.
" }, "PendingUpdate":{ "shape":"PendingUpdate", "documentation":"A PendingUpdate object. Contains details for the pending updates for the team, if applicable.
ID for the approver.
" }, "ResponseTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the approver responded to an approval team invitation.
" }, "PrimaryIdentityId":{ "shape":"IdentityId", "documentation":"ID for the user.
" }, "PrimaryIdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.
" }, "PrimaryIdentityStatus":{ "shape":"IdentityStatus", "documentation":"Status for the identity source. For example, if an approver has accepted a team invitation with a user authentication method managed by the identity source.
" }, "LastActivity":{ "shape":"ApproverLastActivity", "documentation":"Last Activity performed by the approver.
" }, "LastActivityTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the approver last responded to an operation or invitation request.
" }, "PendingBaselineSessionArn":{ "shape":"SessionArn", "documentation":"Amazon Resource Name (ARN) for the pending baseline session.
" }, "MfaMethods":{ "shape":"MfaMethods", "documentation":"Multi-factor authentication configuration for the approver
" } }, "documentation":"Contains details for an approver.
" }, "GetApprovalTeamResponseApprovers":{ "type":"list", "member":{"shape":"GetApprovalTeamResponseApprover"}, "max":20, "min":0 }, "GetIdentitySourceRequest":{ "type":"structure", "required":["IdentitySourceArn"], "members":{ "IdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the identity source.
", "location":"uri", "locationName":"IdentitySourceArn" } } }, "GetIdentitySourceResponse":{ "type":"structure", "members":{ "IdentitySourceType":{ "shape":"IdentitySourceType", "documentation":"The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance.
" }, "IdentitySourceParameters":{ "shape":"IdentitySourceParametersForGet", "documentation":"A IdentitySourceParameters object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
Amazon Resource Name (ARN) for the identity source.
" }, "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the identity source was created.
" }, "Status":{ "shape":"IdentitySourceStatus", "documentation":"Status for the identity source. For example, if the identity source is ACTIVE.
Status code of the identity source.
" }, "StatusMessage":{ "shape":"String", "documentation":"Message describing the status for the identity source.
" } } }, "GetPolicyVersionRequest":{ "type":"structure", "required":["PolicyVersionArn"], "members":{ "PolicyVersionArn":{ "shape":"QualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the policy.
", "location":"uri", "locationName":"PolicyVersionArn" } } }, "GetPolicyVersionResponse":{ "type":"structure", "required":["PolicyVersion"], "members":{ "PolicyVersion":{ "shape":"PolicyVersion", "documentation":"A PolicyVersion object. Contains details for the version of the policy. Policies define the permissions for team resources.
Amazon Resource Name (ARN) for the resource.
" }, "PolicyName":{ "shape":"String", "documentation":"Name of the policy.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy.
" } } }, "GetResourcePolicyResponse":{ "type":"structure", "required":[ "ResourceArn", "PolicyType", "PolicyName", "PolicyDocument" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the resource.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy
" }, "PolicyVersionArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the policy version.
" }, "PolicyName":{ "shape":"PolicyName", "documentation":"Name of the policy.
" }, "PolicyDocument":{ "shape":"PolicyDocument", "documentation":"Document that contains the contents for the policy.
" } } }, "GetSessionRequest":{ "type":"structure", "required":["SessionArn"], "members":{ "SessionArn":{ "shape":"SessionArn", "documentation":"Amazon Resource Name (ARN) for the session.
", "location":"uri", "locationName":"SessionArn" } } }, "GetSessionResponse":{ "type":"structure", "members":{ "SessionArn":{ "shape":"SessionArn", "documentation":"Amazon Resource Name (ARN) for the session.
" }, "ApprovalTeamArn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the approval team.
" }, "ApprovalTeamName":{ "shape":"ApprovalTeamName", "documentation":"Name of the approval team.
" }, "ProtectedResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the protected operation.
" }, "ApprovalStrategy":{ "shape":"ApprovalStrategyResponse", "documentation":"An ApprovalStrategyResponse object. Contains details for how the team grants approval
Total number of approvers in the session.
" }, "InitiationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session was initiated.
" }, "ExpirationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session will expire.
" }, "CompletionTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session completed.
" }, "Description":{ "shape":"Description", "documentation":"Description for the session.
" }, "Metadata":{ "shape":"SessionMetadata", "documentation":"Metadata for the session.
" }, "Status":{ "shape":"SessionStatus", "documentation":"Status for the session. For example, if the team has approved the requested operation.
" }, "StatusCode":{ "shape":"SessionStatusCode", "documentation":"Status code of the session.
" }, "StatusMessage":{ "shape":"Message", "documentation":"Message describing the status for session.
" }, "ExecutionStatus":{ "shape":"SessionExecutionStatus", "documentation":"Status for the protected operation. For example, if the operation is PENDING.
Name of the protected operation.
" }, "RequesterServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"Service principal for the service associated with the protected operation.
" }, "RequesterPrincipalArn":{ "shape":"String", "documentation":"IAM principal that made the operation request.
" }, "RequesterAccountId":{ "shape":"AccountId", "documentation":"ID for the account that made the operation request.
" }, "RequesterRegion":{ "shape":"Region", "documentation":"Amazon Web Services Region where the operation request originated.
" }, "RequesterComment":{ "shape":"RequesterComment", "documentation":"Message from the account that made the operation request
" }, "ActionCompletionStrategy":{ "shape":"ActionCompletionStrategy", "documentation":"Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.
An array of GetSessionResponseApproverResponse objects. Contains details for approver responses in the session.
A list of AdditionalSecurityRequirement applied to the session.
ID for the approver.
" }, "IdentitySourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.
" }, "IdentityId":{ "shape":"IdentityId", "documentation":"ID for the identity source. The identity source manages the user authentication for approvers.
" }, "Response":{ "shape":"SessionResponse", "documentation":"Response to the operation request.
" }, "ResponseTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when a approver responded to the operation request.
" } }, "documentation":"Contains details for an approver response in an approval session.
" }, "GetSessionResponseApproverResponses":{ "type":"list", "member":{"shape":"GetSessionResponseApproverResponse"}, "max":20, "min":0 }, "IamIdentityCenter":{ "type":"structure", "required":[ "InstanceArn", "Region" ], "members":{ "InstanceArn":{ "shape":"IdcInstanceArn", "documentation":"Amazon Resource Name (ARN) for the IAM Identity Center instance.
" }, "Region":{ "shape":"String", "documentation":"Amazon Web Services Region where the IAM Identity Center instance is located.
" } }, "documentation":"IAM Identity Center credentials. For more information see, IAM Identity Center .
" }, "IamIdentityCenterForGet":{ "type":"structure", "members":{ "InstanceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the IAM Identity Center instance.
" }, "ApprovalPortalUrl":{ "shape":"String", "documentation":"URL for the approval portal associated with the IAM Identity Center instance.
" }, "Region":{ "shape":"String", "documentation":"Amazon Web Services Region where the IAM Identity Center instance is located.
" } }, "documentation":"IAM Identity Center credentials. For more information see, IAM Identity Center .
" }, "IamIdentityCenterForList":{ "type":"structure", "members":{ "InstanceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the IAM Identity Center instance.
" }, "ApprovalPortalUrl":{ "shape":"String", "documentation":"URL for the approval portal associated with the IAM Identity Center instance.
" }, "Region":{ "shape":"String", "documentation":"Amazon Web Services Region where the IAM Identity Center instance is located.
" } }, "documentation":"IAM Identity Center credentials. For more information see, IAM Identity Center .
" }, "IdcInstanceArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:.+:sso:::instance/(?:sso)?ins-[a-zA-Z0-9-.]{16}" }, "IdentityId":{ "type":"string", "max":100, "min":1 }, "IdentitySourceForList":{ "type":"structure", "members":{ "IdentitySourceType":{ "shape":"IdentitySourceType", "documentation":"The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance.
" }, "IdentitySourceParameters":{ "shape":"IdentitySourceParametersForList", "documentation":"A IdentitySourceParametersForList object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
Amazon Resource Name (ARN) for the identity source.
" }, "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the identity source was created.
" }, "Status":{ "shape":"IdentitySourceStatus", "documentation":"Status for the identity source. For example, if the identity source is ACTIVE.
Status code of the identity source.
" }, "StatusMessage":{ "shape":"String", "documentation":"Message describing the status for the identity source.
" } }, "documentation":"Contains details for an identity source. For more information, see Identity source in the Multi-party approval User Guide.
" }, "IdentitySourceParameters":{ "type":"structure", "members":{ "IamIdentityCenter":{ "shape":"IamIdentityCenter", "documentation":"IAM Identity Center credentials.
" } }, "documentation":"Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.
" }, "IdentitySourceParametersForGet":{ "type":"structure", "members":{ "IamIdentityCenter":{ "shape":"IamIdentityCenterForGet", "documentation":"IAM Identity Center credentials.
" } }, "documentation":"Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance. For more information, see Identity source in the Multi-party approval User Guide.
", "union":true }, "IdentitySourceParametersForList":{ "type":"structure", "members":{ "IamIdentityCenter":{ "shape":"IamIdentityCenterForList", "documentation":"IAM Identity Center credentials.
" } }, "documentation":"Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance. For more information, see Identity source in the Multi-party approval User Guide.
", "union":true }, "IdentitySourceStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "ERROR" ] }, "IdentitySourceStatusCode":{ "type":"string", "enum":[ "ACCESS_DENIED", "DELETION_FAILED", "IDC_INSTANCE_NOT_FOUND", "IDC_INSTANCE_NOT_VALID" ] }, "IdentitySourceType":{ "type":"string", "enum":["IAM_IDENTITY_CENTER"] }, "IdentitySources":{ "type":"list", "member":{"shape":"IdentitySourceForList"}, "max":20, "min":0 }, "IdentityStatus":{ "type":"string", "enum":[ "PENDING", "ACCEPTED", "REJECTED", "INVALID" ] }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the InternalServerException error.
The service encountered an internal error. Try your request again. If the problem persists, contact Amazon Web Services Support.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "InvalidParameterException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the InvalidParameterException error.
The request contains an invalid parameter value.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "IsoTimestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "ListApprovalTeamsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of ListApprovalTeamsResponseApprovalTeam objects. Contains details for approval teams.
Timestamp when the team was created.
" }, "ApprovalStrategy":{ "shape":"ApprovalStrategyResponse", "documentation":"An ApprovalStrategyResponse object. Contains details for how an approval team grants approval.
Total number of approvers in the team.
" }, "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the team.
" }, "Name":{ "shape":"ApprovalTeamName", "documentation":"Name of the team.
" }, "Description":{ "shape":"Description", "documentation":"Description for the team.
" }, "Status":{ "shape":"ApprovalTeamStatus", "documentation":"Status for the team. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusCode":{ "shape":"ApprovalTeamStatusCode", "documentation":"Status code for the team. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusMessage":{ "shape":"Message", "documentation":"Message describing the status for the team.
" } }, "documentation":"Contains details for an approval team
" }, "ListApprovalTeamsResponseApprovalTeams":{ "type":"list", "member":{"shape":"ListApprovalTeamsResponseApprovalTeam"}, "max":20, "min":0 }, "ListIdentitySourcesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
A IdentitySources. Contains details for identity sources.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of Policy objects. Contains a list of policies that define the permissions for team resources.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
Amazon Resource Name (ARN) for the policy.
", "location":"uri", "locationName":"PolicyArn" } } }, "ListPolicyVersionsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of PolicyVersionSummary objects. Contains details for the version of the policies that define the permissions for team resources.
Amazon Resource Name (ARN) for the resource.
", "location":"uri", "locationName":"ResourceArn" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of ListResourcePoliciesResponseResourcePolicy objects. Contains details about the policy for the resource.
Amazon Resource Name (ARN) for policy.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy.
" }, "PolicyName":{ "shape":"String", "documentation":"Name of the policy.
" } }, "documentation":"Contains details about a policy for a resource.
" }, "ListSessionsRequest":{ "type":"structure", "required":["ApprovalTeamArn"], "members":{ "ApprovalTeamArn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the approval team.
", "location":"uri", "locationName":"ApprovalTeamArn" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of Filter objects. Contains the filter to apply when listing sessions.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.
An array of ListSessionsResponseSession objects. Contains details for the sessions.
Amazon Resource Name (ARN) for the session.
" }, "ApprovalTeamName":{ "shape":"ApprovalTeamName", "documentation":"Name of the approval team.
" }, "ApprovalTeamArn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the approval team.
" }, "InitiationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session was initiated.
" }, "ExpirationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session was expire.
" }, "CompletionTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the session was completed.
" }, "Description":{ "shape":"Description", "documentation":"Description for the team.
" }, "ActionName":{ "shape":"ActionName", "documentation":"Name of the protected operation.
" }, "ProtectedResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the protected operation.
" }, "RequesterServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"Service principal for the service associated with the protected operation.
" }, "RequesterPrincipalArn":{ "shape":"String", "documentation":"IAM principal that made the operation request.
" }, "RequesterRegion":{ "shape":"Region", "documentation":"Amazon Web Services Region where the operation request originated.
" }, "RequesterAccountId":{ "shape":"AccountId", "documentation":"ID for the account that made the operation request.
" }, "Status":{ "shape":"SessionStatus", "documentation":"Status for the protected operation. For example, if the operation is PENDING.
Status code of the session.
" }, "StatusMessage":{ "shape":"Message", "documentation":"Message describing the status for session.
" }, "ActionCompletionStrategy":{ "shape":"ActionCompletionStrategy", "documentation":"Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is executed automatically using the requester's permissions, if approved.
A list of AdditionalSecurityRequirement applied to the session.
Contains details for an approval session. For more information, see Session in the Multi-party approval User Guide
" }, "ListSessionsResponseSessions":{ "type":"list", "member":{"shape":"ListSessionsResponseSession"}, "max":20, "min":0 }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the resource.
", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"Tags attached to the resource.
" } } }, "MaxResults":{ "type":"integer", "box":true, "max":20, "min":1 }, "Message":{ "type":"string", "max":500, "min":0 }, "MfaMethod":{ "type":"structure", "required":[ "Type", "SyncStatus" ], "members":{ "Type":{ "shape":"MfaType", "documentation":"The type of MFA configuration used by the approver
" }, "SyncStatus":{ "shape":"MfaSyncStatus", "documentation":"Indicates if the approver's MFA device is in-sync with the Identity Source
" } }, "documentation":"MFA configuration and sycnronization status for an approver
" }, "MfaMethods":{ "type":"list", "member":{"shape":"MfaMethod"}, "max":5, "min":0 }, "MfaSyncStatus":{ "type":"string", "documentation":"Indicates if the approver's MFA device is in-sync with the Identity Source
IN_SYNC: The approver's MFA device is in-sync with the Identity Source
OUT_OF_SYNC: The approver's MFA device is out-of-sync with the Identity Source
The type of MFA device used by the approver
EMAIL_OTP: The approver will receive emailed one-time passwords to their primary email
Minimum number of approvals (M) required for a total number of approvers (N).
" } }, "documentation":"Strategy for how an approval team grants approval.
" }, "MofNApprovalStrategyMinApprovalsRequiredInteger":{ "type":"integer", "box":true, "min":1 }, "Operator":{ "type":"string", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "CONTAINS", "NOT_CONTAINS", "BETWEEN" ] }, "ParticipantId":{ "type":"string", "max":100, "min":1 }, "PendingUpdate":{ "type":"structure", "members":{ "VersionId":{ "shape":"String", "documentation":"Version ID for the team.
" }, "Description":{ "shape":"String", "documentation":"Description for the team.
" }, "ApprovalStrategy":{ "shape":"ApprovalStrategyResponse", "documentation":"An ApprovalStrategyResponse object. Contains details for how the team grants approval.
Total number of approvers in the team.
" }, "Status":{ "shape":"ApprovalTeamStatus", "documentation":"Status for the team. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusCode":{ "shape":"ApprovalTeamStatusCode", "documentation":"Status code for the update. For more information, see Team health in the Multi-party approval User Guide.
" }, "StatusMessage":{ "shape":"Message", "documentation":"Message describing the status for the team.
" }, "Approvers":{ "shape":"GetApprovalTeamResponseApprovers", "documentation":"An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.
Timestamp when the update request was initiated.
" } }, "documentation":"Contains details for the pending updates for an approval team, if applicable.
" }, "Policies":{ "type":"list", "member":{"shape":"Policy"}, "max":20, "min":0 }, "PoliciesReferences":{ "type":"list", "member":{"shape":"PolicyReference"}, "max":10, "min":1 }, "Policy":{ "type":"structure", "required":[ "Arn", "DefaultVersion", "PolicyType", "Name" ], "members":{ "Arn":{ "shape":"UnqualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the policy.
" }, "DefaultVersion":{ "shape":"PolicyVersionId", "documentation":"Determines if the specified policy is the default for the team.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy.
" }, "Name":{ "shape":"PolicyName", "documentation":"Name of the policy.
" } }, "documentation":"Contains details for a policy. Policies define what operations a team that define the permissions for team resources.
" }, "PolicyDocument":{ "type":"string", "max":400000, "min":0, "sensitive":true }, "PolicyName":{ "type":"string", "max":64, "min":0 }, "PolicyReference":{ "type":"structure", "required":["PolicyArn"], "members":{ "PolicyArn":{ "shape":"QualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the policy.
" } }, "documentation":"Contains the Amazon Resource Name (ARN) for a policy. Policies define what operations a team that define the permissions for team resources.
" }, "PolicyStatus":{ "type":"string", "enum":[ "ATTACHABLE", "DEPRECATED" ] }, "PolicyType":{ "type":"string", "enum":[ "AWS_MANAGED", "AWS_RAM" ] }, "PolicyVersion":{ "type":"structure", "required":[ "Arn", "PolicyArn", "VersionId", "PolicyType", "IsDefault", "Name", "Status", "CreationTime", "LastUpdatedTime", "Document" ], "members":{ "Arn":{ "shape":"QualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the team.
" }, "PolicyArn":{ "shape":"UnqualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the policy.
" }, "VersionId":{ "shape":"PolicyVersionId", "documentation":"Verison ID
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy.
" }, "IsDefault":{ "shape":"Boolean", "documentation":"Determines if the specified policy is the default for the team.
" }, "Name":{ "shape":"PolicyName", "documentation":"Name of the policy.
" }, "Status":{ "shape":"PolicyStatus", "documentation":"Status for the policy. For example, if the policy is attachable or deprecated.
" }, "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the policy was created.
" }, "LastUpdatedTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the policy was last updated.
" }, "Document":{ "shape":"PolicyDocument", "documentation":"Document that contains the policy contents.
" } }, "documentation":"Contains details for the version of a policy. Policies define what operations a team that define the permissions for team resources.
" }, "PolicyVersionId":{ "type":"integer", "box":true, "min":1 }, "PolicyVersionSummary":{ "type":"structure", "required":[ "Arn", "PolicyArn", "VersionId", "PolicyType", "IsDefault", "Name", "Status", "CreationTime", "LastUpdatedTime" ], "members":{ "Arn":{ "shape":"QualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the team.
" }, "PolicyArn":{ "shape":"UnqualifiedPolicyArn", "documentation":"Amazon Resource Name (ARN) for the policy.
" }, "VersionId":{ "shape":"PolicyVersionId", "documentation":"Version ID for the policy.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The type of policy.
" }, "IsDefault":{ "shape":"Boolean", "documentation":"Determines if the specified policy is the default for the team.
" }, "Name":{ "shape":"PolicyName", "documentation":"Name of the policy
" }, "Status":{ "shape":"PolicyStatus", "documentation":"Status for the policy. For example, if the policy is attachable or deprecated.
" }, "CreationTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the policy was created.
" }, "LastUpdatedTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the policy was last updated.
" } }, "documentation":"Contains details for the version of a policy. Policies define what operations a team that define the permissions for team resources.
" }, "PolicyVersions":{ "type":"list", "member":{"shape":"PolicyVersionSummary"}, "max":20, "min":0 }, "QualifiedPolicyArn":{ "type":"string", "max":1224, "min":0, "pattern":"arn:.{1,63}:mpa:::aws:policy/[a-zA-Z0-9_\\.-]{1,1023}/[a-zA-Z0-9_\\.-]{1,1023}/(?:[\\d]+|\\$DEFAULT)" }, "Region":{ "type":"string", "max":100, "min":0 }, "RequesterComment":{ "type":"string", "max":200, "min":0, "sensitive":true }, "ResourceNotFoundException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the ResourceNotFoundException error.
The specified resource doesn't exist. Check the resource ID, and try again.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServicePrincipal":{ "type":"string", "max":100, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the ServiceQuotaExceededException error.
The request exceeds the service quota for your account. Request a quota increase or reduce your request size.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SessionArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:mpa:[a-z0-9-]{1,20}:[0-9]{12}:session/[a-zA-Z0-9._-]+/[a-zA-Z0-9_-]+" }, "SessionExecutionStatus":{ "type":"string", "enum":[ "EXECUTED", "FAILED", "PENDING" ] }, "SessionKey":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9\\p{P}]*", "sensitive":true }, "SessionMetadata":{ "type":"map", "key":{"shape":"SessionKey"}, "value":{"shape":"SessionValue"}, "sensitive":true }, "SessionResponse":{ "type":"string", "enum":[ "APPROVED", "REJECTED", "NO_RESPONSE" ] }, "SessionStatus":{ "type":"string", "enum":[ "PENDING", "CANCELLED", "APPROVED", "FAILED", "CREATING" ] }, "SessionStatusCode":{ "type":"string", "enum":[ "REJECTED", "EXPIRED", "CONFIGURATION_CHANGED", "ALL_APPROVERS_IN_SESSION" ] }, "SessionValue":{ "type":"string", "max":200, "min":1, "pattern":"[a-zA-Z0-9\\p{P}]*", "sensitive":true }, "StartActiveApprovalTeamDeletionRequest":{ "type":"structure", "required":["Arn"], "members":{ "PendingWindowDays":{ "shape":"Integer", "documentation":"Number of days between when the team approves the delete request and when the team is deleted.
" }, "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the team.
", "location":"uri", "locationName":"Arn" } } }, "StartActiveApprovalTeamDeletionResponse":{ "type":"structure", "members":{ "DeletionCompletionTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the deletion process is scheduled to complete.
" }, "DeletionStartTime":{ "shape":"IsoTimestamp", "documentation":"Timestamp when the deletion process was initiated.
" } } }, "StartApprovalTeamBaselineApproverIds":{ "type":"list", "member":{"shape":"ParticipantId"}, "max":20, "min":0 }, "StartApprovalTeamBaselineRequest":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the approval team.
", "location":"uri", "locationName":"Arn" }, "ApproverIds":{ "shape":"StartApprovalTeamBaselineApproverIds", "documentation":"Array of approver IDs.
" } } }, "StartApprovalTeamBaselineResponse":{ "type":"structure", "members":{ "BaselineSessionArn":{ "shape":"SessionArn", "documentation":"Amazon Resource Name (ARN) for the session.
" } } }, "String":{ "type":"string", "max":1000, "min":0 }, "TagKey":{ "type":"string", "max":128, "min":1, "sensitive":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0, "sensitive":true }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the resource you want to tag.
", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"Tags", "documentation":"Tags that you have added to the specified resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0, "sensitive":true }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "sensitive":true }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the ThrottlingException error.
The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Token":{ "type":"string", "max":4096, "min":0 }, "TooManyTagsException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the TooManyTagsException error.
Name of the resource for the TooManyTagsException error.
The request exceeds the maximum number of tags allowed for this resource. Remove some tags, and try again.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnqualifiedPolicyArn":{ "type":"string", "max":1224, "min":0, "pattern":"arn:.{1,63}:mpa:::aws:policy/[a-zA-Z0-9_\\.-]{1,1023}/[a-zA-Z0-9_\\.-]{1,1023}" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"Amazon Resource Name (ARN) for the resource you want to untag.
", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"Array of tag key-value pairs that you want to untag.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateAction":{ "type":"string", "documentation":"Actions that can be taken when updating an approval team
SYNCHRONIZE_MFA_DEVICES: Synchronize MFA devices for all approvers on the team
An ApprovalStrategy object. Contains details for how the team grants approval.
An array of ApprovalTeamRequestApprover objects. Contains details for the approvers in the team.
Description for the team.
" }, "Arn":{ "shape":"ApprovalTeamArn", "documentation":"Amazon Resource Name (ARN) for the team.
", "location":"uri", "locationName":"Arn" }, "UpdateActions":{ "shape":"UpdateActions", "documentation":"A list of UpdateAction to perform when updating the team.
Version ID for the team that was created. When an approval team is updated, the version ID changes.
" } } }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Message for the ValidationException error.
The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"Multi-party approval is a capability of Organizations that allows you to protect a predefined list of operations through a distributed approval process. Use Multi-party approval to establish approval workflows and transform security processes into team-based decisions.
When to use Multi-party approval:
You need to align with the Zero Trust principle of \"never trust, always verify\"
You need to make sure that the right humans have access to the right things in the right way
You need distributed decision-making for sensitive or critical operations
You need to protect against unintended operations on sensitive or critical resources
You need formal reviews and approvals for auditing or compliance reasons
For more information, see What is Multi-party approval in the Multi-party approval User Guide.
" }