/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSMContacts::StartEngagement

NAME

Paws::SSMContacts::StartEngagement - Arguments for method StartEngagement on Paws::SSMContacts

DESCRIPTION

This class represents the parameters used for calling the method StartEngagement on the AWS Systems Manager Incident Manager Contacts service. Use the attributes of this class as arguments to method StartEngagement.

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

SYNOPSIS

my $ssm-contacts = Paws->service('SSMContacts');
my $StartEngagementResult = $ssm -contacts->StartEngagement(
  ContactId        => 'MySsmContactsArn',
  Content          => 'MyContent',
  Sender           => 'MySender',
  Subject          => 'MySubject',
  IdempotencyToken => 'MyIdempotencyToken',    # OPTIONAL
  IncidentId       => 'MyIncidentId',          # OPTIONAL
  PublicContent    => 'MyPublicContent',       # OPTIONAL
  PublicSubject    => 'MyPublicSubject',       # OPTIONAL
);

# Results:
my $EngagementArn = $StartEngagementResult->EngagementArn;

# Returns a L<Paws::SSMContacts::StartEngagementResult> 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/ssm-contacts/StartEngagement

ATTRIBUTES

REQUIRED ContactId => Str

The Amazon Resource Name (ARN) of the contact being engaged.

REQUIRED Content => Str

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

IdempotencyToken => Str

A token ensuring that the action is called only once with the specified details.

IncidentId => Str

The ARN of the incident that the engagement is part of.

PublicContent => Str

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

PublicSubject => Str

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

REQUIRED Sender => Str

The user that started the engagement.

REQUIRED Subject => Str

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartEngagement in Paws::SSMContacts

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