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

get-ingress-point

Description

Fetch ingress endpoint resource attributes.

See also: AWS API Documentation

Synopsis

  get-ingress-point
--ingress-point-id <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

--ingress-point-id (string)

The identifier of an ingress endpoint.

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

ARecord -> (string)

The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

CreatedTimestamp -> (timestamp)

The timestamp of when the ingress endpoint was created.

IngressPointArn -> (string)

The Amazon Resource Name (ARN) of the ingress endpoint resource.

IngressPointAuthConfiguration -> (structure)

The authentication configuration of the ingress endpoint resource.

IngressPointPasswordConfiguration -> (structure)

The ingress endpoint password configuration for the ingress endpoint resource.

PreviousSmtpPasswordExpiryTimestamp -> (timestamp)

The previous password expiry timestamp of the ingress endpoint resource.

PreviousSmtpPasswordVersion -> (string)

The previous password version of the ingress endpoint resource.

SmtpPasswordVersion -> (string)

The current password expiry timestamp of the ingress endpoint resource.

SecretArn -> (string)

The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.

IngressPointId -> (string)

The identifier of an ingress endpoint resource.

IngressPointName -> (string)

A user friendly name for the ingress endpoint.

LastUpdatedTimestamp -> (timestamp)

The timestamp of when the ingress endpoint was last updated.

RuleSetId -> (string)

The identifier of a rule set resource associated with the ingress endpoint.

Status -> (string)

The status of the ingress endpoint resource.

TrafficPolicyId -> (string)

The identifier of the traffic policy resource associated with the ingress endpoint.

Type -> (string)

The type of ingress endpoint.