NAME

Paws::Health::DescribeAffectedEntities - Arguments for method DescribeAffectedEntities on Paws::Health

DESCRIPTION

This class represents the parameters used for calling the method DescribeAffectedEntities on the AWS Health APIs and Notifications service. Use the attributes of this class as arguments to method DescribeAffectedEntities.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAffectedEntities.

SYNOPSIS

    my $health = Paws->service('Health');
    my $DescribeAffectedEntitiesResponse = $health->DescribeAffectedEntities(
      Filter => {
        EventArns => [
          'MyeventArn', ...    # max: 1600
        ],    # min: 1, max: 10
        EntityArns => [
          'MyentityArn', ...    # max: 1600
        ],    # min: 1, max: 100; OPTIONAL
        EntityValues => [
          'MyentityValue', ...    # max: 1224
        ],    # min: 1, max: 100; OPTIONAL
        LastUpdatedTimes => [
          {
            From => '1970-01-01T01:00:00',    # OPTIONAL
            To   => '1970-01-01T01:00:00',    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
        StatusCodes => [
          'IMPAIRED', ...    # values: IMPAIRED, UNIMPAIRED, UNKNOWN
        ],    # min: 1, max: 3; OPTIONAL
        Tags => [
          {
            'MytagKey' => 'MytagValue',    # key: max: 127, value: max: 255
          },
          ...                              # max: 50
        ],    # max: 50; OPTIONAL
      },
      Locale     => 'Mylocale',       # OPTIONAL
      MaxResults => 1,                # OPTIONAL
      NextToken  => 'MynextToken',    # OPTIONAL
    );

    # Results:
    my $Entities  = $DescribeAffectedEntitiesResponse->Entities;
    my $NextToken = $DescribeAffectedEntitiesResponse->NextToken;

    # Returns a L<Paws::Health::DescribeAffectedEntitiesResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/health/DescribeAffectedEntities

ATTRIBUTES

REQUIRED Filter => Paws::Health::EntityFilter

Values to narrow the results returned. At least one event ARN is required.

Locale => Str

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

MaxResults => Int

The maximum number of items to return in one batch, between 10 and 100, inclusive.

NextToken => Str

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeAffectedEntities in Paws::Health

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues