Class: Aws::ApplicationSignals::Types::ListEntityEventsInput

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationSignals::Types::ListEntityEventsInput

Defined in:

gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end of the time period to retrieve change events for.

• #entity ⇒ Hash<String,String>

  The entity for which to retrieve change events.

• #max_results ⇒ Integer

  The maximum number of change events to return in one operation.

• #next_token ⇒ String

  Include this value, if it was returned by the previous operation, to get the next set of change events.

• #start_time ⇒ Time

  The start of the time period to retrieve change events for.

Instance Attribute Details

#end_time ⇒ Time

The end of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

Returns:

• (Time)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2206

class ListEntityEventsInput < Struct.new(
  :entity,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#entity ⇒ Hash<String,String>

The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.

This is a string-to-string map. It can include the following fields.

• Type designates the type of object this is.

• ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

• Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

• Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

• Environment specifies the location where this object is hosted, or what it belongs to.

• AwsAccountId specifies the account where this object is in.

Below is an example of a service.

{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }

Below is an example of a resource.

{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2206

class ListEntityEventsInput < Struct.new(
  :entity,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of change events to return in one operation. If you omit this parameter, the default of 50 is used.

Returns:

• (Integer)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2206

class ListEntityEventsInput < Struct.new(
  :entity,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Include this value, if it was returned by the previous operation, to get the next set of change events.

Returns:

• (String)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2206

class ListEntityEventsInput < Struct.new(
  :entity,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: 1698778057

Returns:

• (Time)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2206

class ListEntityEventsInput < Struct.new(
  :entity,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end