« blib/lib/Paws/SSOOidc/RegisterClientResponse.pm
↑ Summary
blib/lib/Paws/SSOOidc/StartDeviceAuthorizationResponse.pm »
| 1 | |||
| 2 | package Paws::SSOOidc::StartDeviceAuthorization; | ||
| 3 | use Moose; | ||
| 4 | has ClientId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientId', required => 1); | ||
| 5 | has ClientSecret => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientSecret', required => 1); | ||
| 6 | has StartUrl => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startUrl', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDeviceAuthorization'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/device_authorization'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSOOidc::StartDeviceAuthorizationResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SSOOidc::StartDeviceAuthorization - Arguments for method StartDeviceAuthorization on L<Paws::SSOOidc> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method StartDeviceAuthorization on the | ||
| 25 | L<AWS SSO OIDC|Paws::SSOOidc> service. Use the attributes of this class | ||
| 26 | as arguments to method StartDeviceAuthorization. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDeviceAuthorization. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $oidc = Paws->service('SSOOidc'); | ||
| 33 | my $StartDeviceAuthorizationResponse = $oidc->StartDeviceAuthorization( | ||
| 34 | ClientId => 'MyClientId', | ||
| 35 | ClientSecret => 'MyClientSecret', | ||
| 36 | StartUrl => 'MyURI', | ||
| 37 | |||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $DeviceCode = $StartDeviceAuthorizationResponse->DeviceCode; | ||
| 42 | my $ExpiresIn = $StartDeviceAuthorizationResponse->ExpiresIn; | ||
| 43 | my $Interval = $StartDeviceAuthorizationResponse->Interval; | ||
| 44 | my $UserCode = $StartDeviceAuthorizationResponse->UserCode; | ||
| 45 | my $VerificationUri = $StartDeviceAuthorizationResponse->VerificationUri; | ||
| 46 | my $VerificationUriComplete = | ||
| 47 | $StartDeviceAuthorizationResponse->VerificationUriComplete; | ||
| 48 | |||
| 49 | # Returns a L<Paws::SSOOidc::StartDeviceAuthorizationResponse> 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/oidc/StartDeviceAuthorization> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ClientId => Str | ||
| 58 | |||
| 59 | The unique identifier string for the client that is registered with AWS | ||
| 60 | SSO. This value should come from the persisted result of the | ||
| 61 | RegisterClient API operation. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> ClientSecret => Str | ||
| 66 | |||
| 67 | A secret string that is generated for the client. This value should | ||
| 68 | come from the persisted result of the RegisterClient API operation. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> StartUrl => Str | ||
| 73 | |||
| 74 | The URL for the AWS SSO user portal. For more information, see Using | ||
| 75 | the User Portal | ||
| 76 | (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html) | ||
| 77 | in the I<AWS Single Sign-On User Guide>. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method StartDeviceAuthorization in L<Paws::SSOOidc> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |