GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::SSM::StartSession(3) User Contributed Perl Documentation Paws::SSM::StartSession(3)

Paws::SSM::StartSession - Arguments for method StartSession on Paws::SSM

This class represents the parameters used for calling the method StartSession on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method StartSession.

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

    my $ssm = Paws->service('SSM');
    my $StartSessionResponse = $ssm->StartSession(
      Target       => 'MySessionTarget',
      DocumentName => 'MyDocumentARN',     # OPTIONAL
      Parameters   => {
        'MySessionManagerParameterName' => [
          'MySessionManagerParameterValue', ...    # min: 1, max: 65535
        ],    # key: min: 1, max: 255
      },    # OPTIONAL
    );
    # Results:
    my $SessionId  = $StartSessionResponse->SessionId;
    my $StreamUrl  = $StartSessionResponse->StreamUrl;
    my $TokenValue = $StartSessionResponse->TokenValue;
    # Returns a L<Paws::SSM::StartSessionResponse> 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/StartSession>

The name of the SSM document to define the parameters and plugin settings for the session. For example, "SSM-SessionManagerRunShell". You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.

Reserved for future use.

REQUIRED Target => Str

The instance to connect to for the session.

This class forms part of Paws, documenting arguments for method StartSession in Paws::SSM

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.