AWS CLI Command Reference

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.

[ aws . pca-connector-scep ]

get-connector

Description

Retrieves details about the specified Connector . Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

See also: AWS API Documentation

Synopsis

  get-connector
--connector-arn <value>
[--cli-input-json <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

--connector-arn (string)

The Amazon Resource Name (ARN) of the connector.

--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.

--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.

--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

Connector -> (structure)

The properties of the connector.

Arn -> (string)

The Amazon Resource Name (ARN) of the connector.

CertificateAuthorityArn -> (string)

The Amazon Resource Name (ARN) of the certificate authority associated with the connector.

Type -> (string)

The connector type.

MobileDeviceManagement -> (tagged union structure)

Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure MobileDeviceManagement , then the connector is for general-purpose use and this object is empty.

Note

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

Intune -> (structure)

Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune .

AzureApplicationId -> (string)

The directory (tenant) ID from your Microsoft Entra ID app registration.

Domain -> (string)

The primary domain from your Microsoft Entra ID app registration.

OpenIdConfiguration -> (structure)

Contains OpenID Connect (OIDC) parameters for use with Connector for SCEP for Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune .

Issuer -> (string)

The issuer value to copy into your Microsoft Entra app registration's OIDC.

Subject -> (string)

The subject value to copy into your Microsoft Entra app registration's OIDC.

Audience -> (string)

The audience value to copy into your Microsoft Entra app registration's OIDC.

Status -> (string)

The connector's status.

StatusReason -> (string)

Information about why connector creation failed, if status is FAILED .

Endpoint -> (string)

The connector's HTTPS public SCEP URL.

CreatedAt -> (timestamp)

The date and time that the connector was created.

UpdatedAt -> (timestamp)

The date and time that the connector was updated.