blib/lib/Paws/SSMContacts/CreateContactChannel.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSMContacts::CreateContactChannel;
3 use Moose;
4 has ContactId => (is => 'ro', isa => 'Str', required => 1);
5 has DeferActivation => (is => 'ro', isa => 'Bool');
6 has DeliveryAddress => (is => 'ro', isa => 'Paws::SSMContacts::ContactChannelAddress', required => 1);
7 has IdempotencyToken => (is => 'ro', isa => 'Str');
8 has Name => (is => 'ro', isa => 'Str', required => 1);
9 has Type => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateContactChannel');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSMContacts::CreateContactChannelResult');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::SSMContacts::CreateContactChannel - Arguments for method CreateContactChannel on L<Paws::SSMContacts>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CreateContactChannel on the
27 L<AWS Systems Manager Incident Manager Contacts|Paws::SSMContacts> service. Use the attributes of this class
28 as arguments to method CreateContactChannel.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateContactChannel.
31  
32 =head1 SYNOPSIS
33  
34 my $ssm-contacts = Paws->service('SSMContacts');
35 my $CreateContactChannelResult = $ssm -contacts->CreateContactChannel(
36 ContactId => 'MySsmContactsArn',
37 DeliveryAddress => {
38 SimpleAddress => 'MySimpleAddress', # min: 1, max: 320; OPTIONAL
39 },
40 Name => 'MyChannelName',
41 Type => 'SMS',
42 DeferActivation => 1, # OPTIONAL
43 IdempotencyToken => 'MyIdempotencyToken', # OPTIONAL
44 );
45  
46 # Results:
47 my $ContactChannelArn = $CreateContactChannelResult->ContactChannelArn;
48  
49 # Returns a L<Paws::SSMContacts::CreateContactChannelResult> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts/CreateContactChannel>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> ContactId => Str
58  
59 The Amazon Resource Name (ARN) of the contact channel.
60  
61  
62  
63 =head2 DeferActivation => Bool
64  
65 If you want to activate the channel at a later time, you can choose to
66 defer activation. Incident Manager can't engage your contact channel
67 until it has been activated.
68  
69  
70  
71 =head2 B<REQUIRED> DeliveryAddress => L<Paws::SSMContacts::ContactChannelAddress>
72  
73 The details that Incident Manager uses when trying to engage the
74 contact channel. The format is dependent on the type of the contact
75 channel. The following are the expected formats:
76  
77 =over
78  
79 =item *
80  
81 SMS - '+' followed by the country code and phone number
82  
83 =item *
84  
85 VOICE - '+' followed by the country code and phone number
86  
87 =item *
88  
89 EMAIL - any standard email format
90  
91 =back
92  
93  
94  
95  
96 =head2 IdempotencyToken => Str
97  
98 A token ensuring that the action is called only once with the specified
99 details.
100  
101  
102  
103 =head2 B<REQUIRED> Name => Str
104  
105 The name of the contact channel.
106  
107  
108  
109 =head2 B<REQUIRED> Type => Str
110  
111 Incident Manager supports three types of contact channels:
112  
113 =over
114  
115 =item *
116  
117 C<SMS>
118  
119 =item *
120  
121 C<VOICE>
122  
123 =item *
124  
125 C<EMAIL>
126  
127 =back
128  
129  
130 Valid values are: C<"SMS">, C<"VOICE">, C<"EMAIL">
131  
132  
133 =head1 SEE ALSO
134  
135 This class forms part of L<Paws>, documenting arguments for method CreateContactChannel in L<Paws::SSMContacts>
136  
137 =head1 BUGS and CONTRIBUTIONS
138  
139 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
140  
141 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
142  
143 =cut
144