list-service-events¶

Description¶

Lists events for a service.

Synopsis¶

  list-service-events
--service-arn <value>
[--event-types <value>]
[--start-time <value>]
[--end-time <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--service-arn (string) [required]

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

--event-types (list)

Filter events by type.

(string)

Possible values:

SERVICE_CREATED

SERVICE_DELETED

SERVICE_SYSTEM_ASSOCIATED

SERVICE_SYSTEM_DISASSOCIATED

SERVICE_RESOURCES_ASSOCIATED

SERVICE_RESOURCES_DISASSOCIATED

SERVICE_WORKFLOW_UPDATED

SERVICE_INPUT_SOURCES_UPDATED

SERVICE_POLICY_ASSOCIATED

SERVICE_POLICY_DISASSOCIATED

SERVICE_FUNCTION_CREATED

SERVICE_FUNCTION_UPDATED

SERVICE_FUNCTION_DELETED

SERVICE_FUNCTION_RESOURCES_ADDED

SERVICE_FUNCTION_RESOURCES_REMOVED

SERVICE_ACHIEVABILITY_UPDATED

ASSERTION_CREATED

ASSERTION_UPDATED

ASSERTION_DELETED

Syntax:

"string" "string" ...

--start-time (timestamp)

The start time for filtering events.

--end-time (timestamp)

The end time for filtering events.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from 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 NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response 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. 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
off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

events -> (list)

The list of service events.

(structure)

Represents an event in the service event log.

eventId -> (string) [required]

The unique identifier of the event.

Constraints:

min: 36

max: 36

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}

timestamp -> (timestamp) [required]

The timestamp of the event.

eventType -> (string) [required]

The type of the event.

Possible values:

SERVICE_CREATED

SERVICE_DELETED

SERVICE_SYSTEM_ASSOCIATED

SERVICE_SYSTEM_DISASSOCIATED

SERVICE_RESOURCES_ASSOCIATED

SERVICE_RESOURCES_DISASSOCIATED

SERVICE_WORKFLOW_UPDATED

SERVICE_INPUT_SOURCES_UPDATED

SERVICE_POLICY_ASSOCIATED

SERVICE_POLICY_DISASSOCIATED

SERVICE_FUNCTION_CREATED

SERVICE_FUNCTION_UPDATED

SERVICE_FUNCTION_DELETED

SERVICE_FUNCTION_RESOURCES_ADDED

SERVICE_FUNCTION_RESOURCES_REMOVED

SERVICE_ACHIEVABILITY_UPDATED

ASSERTION_CREATED

ASSERTION_UPDATED

ASSERTION_DELETED

serviceArn -> (string) [required]

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

actor -> (structure) [required]

The actor that triggered the event.

type -> (string) [required]

The type of actor, either USER or SYSTEM.

Possible values:

USER

SYSTEM

principalId -> (string) [required]

The principal ID of the actor.

accountId -> (string)

The AWS account ID of the actor.

userName -> (string)

The user name of the actor.

eventDetails -> (structure) [required]

The details of the event.

title -> (string) [required]

The title of the event.

description -> (string) [required]

The description of the event.

eventMetadata -> (tagged union structure)

Type-specific metadata for each service event type.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: serviceCreated, serviceDeleted, serviceSystemAssociated, serviceSystemDisassociated, serviceResourcesAssociated, serviceResourcesDisassociated, serviceWorkflowUpdated, serviceInputSourcesUpdated, servicePolicyAssociated, servicePolicyDisassociated, serviceFunctionCreated, serviceFunctionUpdated, serviceFunctionDeleted, serviceFunctionResourcesAdded, serviceFunctionResourcesRemoved, serviceAchievabilityUpdated, assertionCreated, assertionUpdated, assertionDeleted.

serviceCreated -> (structure)

Metadata for a service created event.

serviceDeleted -> (structure)

Metadata for a service deleted event.

serviceSystemAssociated -> (structure)

Metadata for a service system associated event.

systemName -> (string)

The name of the associated system.

systemArn -> (string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceSystemDisassociated -> (structure)

Metadata for a service system disassociated event.

systemId -> (string)

The identifier of the disassociated system.

systemName -> (string)

The name of the disassociated system.

systemArn -> (string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceResourcesAssociated -> (structure)

Metadata for a service resources associated event.

resourceCount -> (integer)

The number of resources associated.

resourceTypes -> (list)

The types of resources associated.

(string)

serviceResourcesDisassociated -> (structure)

Metadata for a service resources disassociated event.

resourceCount -> (integer)

The number of resources disassociated.

resourceTypes -> (list)

The types of resources disassociated.

(string)

serviceWorkflowUpdated -> (structure)

Metadata for a service workflow updated event.

serviceFunctionId -> (string)

The identifier of the service function.

serviceFunctionName -> (string)

The name of the service function.

serviceInputSourcesUpdated -> (structure)

Metadata for a service input sources updated event.

servicePolicyAssociated -> (structure)

Metadata for a service policy associated event.

policyName -> (string)

The name of the associated policy.

policyArn -> (string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

servicePolicyDisassociated -> (structure)

Metadata for a service policy disassociated event.

policyName -> (string)

The name of the disassociated policy.

policyArn -> (string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceFunctionCreated -> (structure)

Metadata for a service function created event.

serviceFunctionId -> (string)

The identifier of the created service function.

serviceFunctionName -> (string)

The name of the created service function.

serviceFunctionUpdated -> (structure)

Metadata for a service function updated event.

serviceFunctionId -> (string)

The identifier of the service function.

serviceFunctionName -> (string)

The name of the service function.

resourcesAdded -> (list)

The list of resource ARNs that were added.

(string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

resourcesRemoved -> (list)

The list of resource ARNs that were removed.

(string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceFunctionDeleted -> (structure)

Metadata for a service function deleted event.

serviceFunctionId -> (string)

The identifier of the deleted service function.

serviceFunctionName -> (string)

The name of the deleted service function.

serviceFunctionResourcesAdded -> (structure)

Metadata for a service function resources added event.

serviceFunctionId -> (string)

The identifier of the service function.

serviceFunctionName -> (string)

The name of the service function.

resourcesAdded -> (list)

The list of resource ARNs that were added.

(string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceFunctionResourcesRemoved -> (structure)

Metadata for a service function resources removed event.

serviceFunctionId -> (string)

The identifier of the service function.

serviceFunctionName -> (string)

The name of the service function.

resourcesRemoved -> (list)

The list of resource ARNs that were removed.

(string)

ARN identifier.

Constraints:

min: 31

pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

serviceAchievabilityUpdated -> (structure)

Metadata for a service achievability updated event.

assessmentId -> (string)

The assessment identifier that triggered the update.

availabilitySlo -> (string)

The updated achievability status of the availability SLO.

multiAzRtoRpo -> (string)

The updated achievability status of the multi-AZ RTO and RPO targets.

multiRegionRtoRpo -> (string)

The updated achievability status of the multi-Region RTO and RPO targets.

assertionCreated -> (structure)

Metadata for an assertion created event.

assertionId -> (string)

The unique identifier of the created assertion.

assertionName -> (string)

The name of the created assertion.

assertionUpdated -> (structure)

Metadata for an assertion updated event.

assertionId -> (string)

The unique identifier of the updated assertion.

assertionName -> (string)

The name of the updated assertion.

assertionDeleted -> (structure)

Metadata for an assertion deleted event.

assertionId -> (string)

The unique identifier of the deleted assertion.

assertionName -> (string)

The name of the deleted assertion.

nextToken -> (string)

Pagination token.

Constraints:

min: 1

max: 2000

pattern: \S{1,2000}

Table of Contents

Feedback

User Guide