blib/lib/Paws/SSM/StartSession.pm untested

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::StartSession;
3 use Moose;
4 has DocumentName => (is => 'ro', isa => 'Str');
5 has Parameters => (is => 'ro', isa => 'Paws::SSM::SessionManagerParameters');
6 has Target => (is => 'ro', isa => 'Str', required => 1);
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartSession');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::StartSessionResponse');
12 class_has _result_key => (isa => 'Str', is => 'ro');
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::SSM::StartSession - Arguments for method StartSession on L<Paws::SSM>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method StartSession on the
24 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
25 as arguments to method StartSession.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSession.
28  
29 =head1 SYNOPSIS
30  
31 my $ssm = Paws->service('SSM');
32 my $StartSessionResponse = $ssm->StartSession(
33 Target => 'MySessionTarget',
34 DocumentName => 'MyDocumentARN', # OPTIONAL
35 Parameters => {
36 'MySessionManagerParameterName' => [
37 'MySessionManagerParameterValue', ... # min: 1, max: 65535
38 ], # key: min: 1, max: 255
39 }, # OPTIONAL
40 );
41  
42 # Results:
43 my $SessionId = $StartSessionResponse->SessionId;
44 my $StreamUrl = $StartSessionResponse->StreamUrl;
45 my $TokenValue = $StartSessionResponse->TokenValue;
46  
47 # Returns a L<Paws::SSM::StartSessionResponse> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/StartSession>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 DocumentName => Str
56  
57 The name of the SSM document to define the parameters and plugin
58 settings for the session. For example, C<SSM-SessionManagerRunShell>.
59 You can call the GetDocument API to verify the document exists before
60 attempting to start a session. If no document name is provided, a shell
61 to the instance is launched by default.
62  
63  
64  
65 =head2 Parameters => L<Paws::SSM::SessionManagerParameters>
66  
67 Reserved for future use.
68  
69  
70  
71 =head2 B<REQUIRED> Target => Str
72  
73 The instance to connect to for the session.
74  
75  
76  
77  
78 =head1 SEE ALSO
79  
80 This class forms part of L<Paws>, documenting arguments for method StartSession in L<Paws::SSM>
81  
82 =head1 BUGS and CONTRIBUTIONS
83  
84 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
85  
86 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
87  
88 =cut
89