The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::SSOOidc::StartDeviceAuthorization - Arguments for method StartDeviceAuthorization on Paws::SSOOidc

DESCRIPTION

This class represents the parameters used for calling the method StartDeviceAuthorization on the AWS SSO OIDC service. Use the attributes of this class as arguments to method StartDeviceAuthorization.

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

SYNOPSIS

    my $oidc = Paws->service('SSOOidc');
    my $StartDeviceAuthorizationResponse = $oidc->StartDeviceAuthorization(
      ClientId     => 'MyClientId',
      ClientSecret => 'MyClientSecret',
      StartUrl     => 'MyURI',

    );

    # Results:
    my $DeviceCode      = $StartDeviceAuthorizationResponse->DeviceCode;
    my $ExpiresIn       = $StartDeviceAuthorizationResponse->ExpiresIn;
    my $Interval        = $StartDeviceAuthorizationResponse->Interval;
    my $UserCode        = $StartDeviceAuthorizationResponse->UserCode;
    my $VerificationUri = $StartDeviceAuthorizationResponse->VerificationUri;
    my $VerificationUriComplete =
      $StartDeviceAuthorizationResponse->VerificationUriComplete;

    # Returns a L<Paws::SSOOidc::StartDeviceAuthorizationResponse> 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/oidc/StartDeviceAuthorization

ATTRIBUTES

REQUIRED ClientId => Str

The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the RegisterClient API operation.

REQUIRED ClientSecret => Str

A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

REQUIRED StartUrl => Str

The URL for the AWS SSO user portal. For more information, see Using the User Portal (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html) in the AWS Single Sign-On User Guide.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartDeviceAuthorization in Paws::SSOOidc

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