Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
describe-redshift-idc-applications¶
Description¶
Lists the Amazon Redshift IAM Identity Center applications.
See also: AWS API Documentation
describe-redshift-idc-applications is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: RedshiftIdcApplications
Synopsis¶
describe-redshift-idc-applications
[--redshift-idc-application-arn <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
Options¶
--redshift-idc-application-arn (string)
The ARN for the Redshift application that integrates with IAM Identity Center.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command's output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
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
--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.
Output¶
RedshiftIdcApplications -> (list)
The list of Amazon Redshift IAM Identity Center applications.
(structure)
Contains properties for the Redshift IDC application.
IdcInstanceArn -> (string)
The ARN for the IAM Identity Center instance that Redshift integrates with.RedshiftIdcApplicationName -> (string)
The name of the Redshift application in IAM Identity Center.RedshiftIdcApplicationArn -> (string)
The ARN for the Redshift application that integrates with IAM Identity Center.IdentityNamespace -> (string)
The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token.IdcDisplayName -> (string)
The display name for the Amazon Redshift IAM Identity Center application. It appears on the console.IamRoleArn -> (string)
The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API.IdcManagedApplicationArn -> (string)
The ARN for the Amazon Redshift IAM Identity Center application.IdcOnboardStatus -> (string)
The onboarding status for the Amazon Redshift IAM Identity Center application.AuthorizedTokenIssuerList -> (list)
The authorized token issuer list for the Amazon Redshift IAM Identity Center application.
(structure)
The authorized token issuer for the Amazon Redshift IAM Identity Center application.
TrustedTokenIssuerArn -> (string)
The ARN for the authorized token issuer for integrating Amazon Redshift with IDC Identity Center.AuthorizedAudiencesList -> (list)
The list of audiences for the authorized token issuer for integrating Amazon Redshift with IDC Identity Center.
(string)
ServiceIntegrations -> (list)
A list of service integrations for the Redshift IAM Identity Center application.
(tagged union structure)
A list of service integrations.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:LakeFormation,S3AccessGrants.LakeFormation -> (list)
A list of scopes set up for Lake Formation integration.
(tagged union structure)
A list of scopes set up for Lake Formation integration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:LakeFormationQuery.LakeFormationQuery -> (structure)
The Lake Formation scope.
Authorization -> (string)
Determines whether the query scope is enabled or disabled.S3AccessGrants -> (list)
A list of scopes set up for S3 Access Grants integration.
(tagged union structure)
A list of scopes set up for S3 Access Grants integration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:ReadWriteAccess.ReadWriteAccess -> (structure)
The S3 Access Grants scope.
Authorization -> (string)
Determines whether the read/write scope is enabled or disabled.
Marker -> (string)
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.