« blib/lib/Paws/SageMaker/DescribeAlgorithmOutput.pm
↑ Summary
blib/lib/Paws/SageMaker/DescribeAppImageConfig.pm »
| 1 | |||
| 2 | package Paws::SageMaker::DescribeApp; | ||
| 3 | use Moose; | ||
| 4 | has AppName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AppType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DomainId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has UserProfileName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeApp'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::DescribeAppResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SageMaker::DescribeApp - Arguments for method DescribeApp on L<Paws::SageMaker> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeApp on the | ||
| 25 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeApp. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeApp. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 33 | my $DescribeAppResponse = $api . sagemaker->DescribeApp( | ||
| 34 | AppName => 'MyAppName', | ||
| 35 | AppType => 'JupyterServer', | ||
| 36 | DomainId => 'MyDomainId', | ||
| 37 | UserProfileName => 'MyUserProfileName', | ||
| 38 | |||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AppArn = $DescribeAppResponse->AppArn; | ||
| 43 | my $AppName = $DescribeAppResponse->AppName; | ||
| 44 | my $AppType = $DescribeAppResponse->AppType; | ||
| 45 | my $CreationTime = $DescribeAppResponse->CreationTime; | ||
| 46 | my $DomainId = $DescribeAppResponse->DomainId; | ||
| 47 | my $FailureReason = $DescribeAppResponse->FailureReason; | ||
| 48 | my $LastHealthCheckTimestamp = | ||
| 49 | $DescribeAppResponse->LastHealthCheckTimestamp; | ||
| 50 | my $LastUserActivityTimestamp = | ||
| 51 | $DescribeAppResponse->LastUserActivityTimestamp; | ||
| 52 | my $ResourceSpec = $DescribeAppResponse->ResourceSpec; | ||
| 53 | my $Status = $DescribeAppResponse->Status; | ||
| 54 | my $UserProfileName = $DescribeAppResponse->UserProfileName; | ||
| 55 | |||
| 56 | # Returns a L<Paws::SageMaker::DescribeAppResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/DescribeApp> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> AppName => Str | ||
| 65 | |||
| 66 | The name of the app. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> AppType => Str | ||
| 71 | |||
| 72 | The type of app. | ||
| 73 | |||
| 74 | Valid values are: C<"JupyterServer">, C<"KernelGateway">, C<"TensorBoard"> | ||
| 75 | |||
| 76 | =head2 B<REQUIRED> DomainId => Str | ||
| 77 | |||
| 78 | The domain ID. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> UserProfileName => Str | ||
| 83 | |||
| 84 | The user profile name. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method DescribeApp in L<Paws::SageMaker> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |