[ aws . mpa ]

get-approval-team

Description

Returns details for an approval team.

See also: AWS API Documentation

Synopsis

  get-approval-team
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--arn (string)

Amazon Resource Name (ARN) for the team.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

CreationTime -> (timestamp)

Timestamp when the team was created.

ApprovalStrategy -> (tagged union structure)

An ApprovalStrategyResponse object. Contains details for how the team grants approval.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: MofN.

MofN -> (structure)

Minimum number of approvals (M) required for a total number of approvers (N).

MinApprovalsRequired -> (integer)

Minimum number of approvals (M) required for a total number of approvers (N).

NumberOfApprovers -> (integer)

Total number of approvers in the team.

Approvers -> (list)

An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.

(structure)

Contains details for an approver.

ApproverId -> (string)

ID for the approver.

ResponseTime -> (timestamp)

Timestamp when the approver responded to an approval team invitation.

PrimaryIdentityId -> (string)

ID for the user.

PrimaryIdentitySourceArn -> (string)

Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.

PrimaryIdentityStatus -> (string)

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.

Arn -> (string)

Amazon Resource Name (ARN) for the team.

Description -> (string)

Description for the team.

Name -> (string)

Name of the approval team.

Status -> (string)

Status for the team. For more information, see Team health in the Multi-party approval User Guide .

StatusCode -> (string)

Status code for the approval team. For more information, see Team health in the Multi-party approval User Guide .

StatusMessage -> (string)

Message describing the status for the team.

UpdateSessionArn -> (string)

Amazon Resource Name (ARN) for the session.

VersionId -> (string)

Version ID for the team.

Policies -> (list)

An array of PolicyReference objects. Contains a list of policies that define the permissions for team resources.

The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide .

(structure)

Contains the Amazon Resource Name (ARN) for a policy. Policies define what operations a team that define the permissions for team resources.

The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide .

PolicyArn -> (string)

Amazon Resource Name (ARN) for the policy.

LastUpdateTime -> (timestamp)

Timestamp when the team was last updated.

PendingUpdate -> (structure)

A PendingUpdate object. Contains details for the pending updates for the team, if applicable.

VersionId -> (string)

Version ID for the team.

Description -> (string)

Description for the team.

ApprovalStrategy -> (tagged union structure)

An ApprovalStrategyResponse object. Contains details for how the team grants approval.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: MofN.

MofN -> (structure)

Minimum number of approvals (M) required for a total number of approvers (N).

MinApprovalsRequired -> (integer)

Minimum number of approvals (M) required for a total number of approvers (N).

NumberOfApprovers -> (integer)

Total number of approvers in the team.

Status -> (string)

Status for the team. For more information, see Team health in the Multi-party approval User Guide .

StatusCode -> (string)

Status code for the update. For more information, see Team health in the Multi-party approval User Guide .

StatusMessage -> (string)

Message describing the status for the team.

Approvers -> (list)

An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.

(structure)

Contains details for an approver.

ApproverId -> (string)

ID for the approver.

ResponseTime -> (timestamp)

Timestamp when the approver responded to an approval team invitation.

PrimaryIdentityId -> (string)

ID for the user.

PrimaryIdentitySourceArn -> (string)

Amazon Resource Name (ARN) for the identity source. The identity source manages the user authentication for approvers.

PrimaryIdentityStatus -> (string)

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.

UpdateInitiationTime -> (timestamp)

Timestamp when the update request was initiated.