« blib/lib/Paws/Finspace/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/Finspace/UpdateEnvironmentResponse.pm »
| 1 | |||
| 2 | package Paws::Finspace::UpdateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 5 | has EnvironmentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'environmentId', required => 1); | ||
| 6 | has FederationMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'federationMode'); | ||
| 7 | has FederationParameters => (is => 'ro', isa => 'Paws::Finspace::FederationParameters', traits => ['NameInRequest'], request_name => 'federationParameters'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnvironment'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/environment/{environmentId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Finspace::UpdateEnvironmentResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Finspace::UpdateEnvironment - Arguments for method UpdateEnvironment on L<Paws::Finspace> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateEnvironment on the | ||
| 27 | L<FinSpace User Environment Management service|Paws::Finspace> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateEnvironment. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnvironment. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $finspace = Paws->service('Finspace'); | ||
| 35 | my $UpdateEnvironmentResponse = $finspace->UpdateEnvironment( | ||
| 36 | EnvironmentId => 'MyIdType', | ||
| 37 | Description => 'MyDescription', # OPTIONAL | ||
| 38 | FederationMode => 'FEDERATED', # OPTIONAL | ||
| 39 | FederationParameters => { | ||
| 40 | ApplicationCallBackURL => 'Myurl', # min: 1, max: 1000; OPTIONAL | ||
| 41 | AttributeMap => { | ||
| 42 | 'MyFederationAttributeKey' => | ||
| 43 | 'Myurl', # key: min: 1, max: 32, value: min: 1, max: 1000; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | FederationProviderName => | ||
| 46 | 'MyFederationProviderName', # min: 1, max: 32; OPTIONAL | ||
| 47 | FederationURN => 'Myurn', # min: 1, max: 255; OPTIONAL | ||
| 48 | SamlMetadataDocument => | ||
| 49 | 'MySamlMetadataDocument', # min: 1000, max: 10000000; OPTIONAL | ||
| 50 | SamlMetadataURL => 'Myurl', # min: 1, max: 1000; OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | Name => 'MyEnvironmentName', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $Environment = $UpdateEnvironmentResponse->Environment; | ||
| 57 | |||
| 58 | # Returns a L<Paws::Finspace::UpdateEnvironmentResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/finspace/UpdateEnvironment> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Description => Str | ||
| 67 | |||
| 68 | The description of the environment. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> EnvironmentId => Str | ||
| 73 | |||
| 74 | The identifier of the FinSpace environment. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 FederationMode => Str | ||
| 79 | |||
| 80 | Authentication mode for the environment. | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<FEDERATED> - Users access FinSpace through Single Sign On (SSO) via | ||
| 87 | your Identity provider. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<LOCAL> - Users access FinSpace via email and password managed within | ||
| 92 | the FinSpace environment. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | Valid values are: C<"FEDERATED">, C<"LOCAL"> | ||
| 98 | |||
| 99 | =head2 FederationParameters => L<Paws::Finspace::FederationParameters> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Name => Str | ||
| 106 | |||
| 107 | The name of the environment. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment in L<Paws::Finspace> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |