« blib/lib/Paws/CloudFormation/ListTypeVersionsOutput.pm
↑ Summary
blib/lib/Paws/CloudFormation/ListTypesOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::ListTypes; | ||
| 3 | use Moose; | ||
| 4 | has DeprecatedStatus => (is => 'ro', isa => 'Str'); | ||
| 5 | has Filters => (is => 'ro', isa => 'Paws::CloudFormation::TypeFilters'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has ProvisioningType => (is => 'ro', isa => 'Str'); | ||
| 9 | has Type => (is => 'ro', isa => 'Str'); | ||
| 10 | has Visibility => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTypes'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::ListTypesOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListTypesResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudFormation::ListTypes - Arguments for method ListTypes on L<Paws::CloudFormation> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListTypes on the | ||
| 28 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 29 | as arguments to method ListTypes. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTypes. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 36 | my $ListTypesOutput = $cloudformation->ListTypes( | ||
| 37 | DeprecatedStatus => 'LIVE', # OPTIONAL | ||
| 38 | Filters => { | ||
| 39 | Category => 'REGISTERED' | ||
| 40 | , # values: REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES; OPTIONAL | ||
| 41 | PublisherId => 'MyPublisherId', # min: 1, max: 40; OPTIONAL | ||
| 42 | TypeNamePrefix => 'MyTypeNamePrefix', # min: 1, max: 204; OPTIONAL | ||
| 43 | }, # OPTIONAL | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 46 | ProvisioningType => 'NON_PROVISIONABLE', # OPTIONAL | ||
| 47 | Type => 'RESOURCE', # OPTIONAL | ||
| 48 | Visibility => 'PUBLIC', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $NextToken = $ListTypesOutput->NextToken; | ||
| 53 | my $TypeSummaries = $ListTypesOutput->TypeSummaries; | ||
| 54 | |||
| 55 | # Returns a L<Paws::CloudFormation::ListTypesOutput> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/ListTypes> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DeprecatedStatus => Str | ||
| 64 | |||
| 65 | The deprecation status of the extension that you want to get summary | ||
| 66 | information about. | ||
| 67 | |||
| 68 | Valid values include: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<LIVE>: The extension is registered for use in CloudFormation | ||
| 75 | operations. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<DEPRECATED>: The extension has been deregistered and can no longer be | ||
| 80 | used in CloudFormation operations. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | |||
| 85 | Valid values are: C<"LIVE">, C<"DEPRECATED"> | ||
| 86 | |||
| 87 | =head2 Filters => L<Paws::CloudFormation::TypeFilters> | ||
| 88 | |||
| 89 | Filter criteria to use in determining which extensions to return. | ||
| 90 | |||
| 91 | If you specify a filter, CloudFormation ignores any specified | ||
| 92 | C<Visibility> value when returning the list of types. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 MaxResults => Int | ||
| 97 | |||
| 98 | The maximum number of results to be returned with a single call. If the | ||
| 99 | number of available results exceeds this maximum, the response includes | ||
| 100 | a C<NextToken> value that you can assign to the C<NextToken> request | ||
| 101 | parameter to get the next set of results. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 NextToken => Str | ||
| 106 | |||
| 107 | If the previous paginated request didn't return all of the remaining | ||
| 108 | results, the response object's C<NextToken> parameter value is set to a | ||
| 109 | token. To retrieve the next set of results, call this action again and | ||
| 110 | assign that token to the request object's C<NextToken> parameter. If | ||
| 111 | there are no remaining results, the previous response object's | ||
| 112 | C<NextToken> parameter is set to C<null>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 ProvisioningType => Str | ||
| 117 | |||
| 118 | For resource types, the provisioning behavior of the resource type. AWS | ||
| 119 | CloudFormation determines the provisioning type during registration, | ||
| 120 | based on the types of handlers in the schema handler package submitted. | ||
| 121 | |||
| 122 | Valid values include: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<FULLY_MUTABLE>: The resource type includes an update handler to | ||
| 129 | process updates to the type during stack update operations. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<IMMUTABLE>: The resource type does not include an update handler, so | ||
| 134 | the type cannot be updated and must instead be replaced during stack | ||
| 135 | update operations. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<NON_PROVISIONABLE>: The resource type does not include create, read, | ||
| 140 | and delete handlers, and therefore cannot actually be provisioned. | ||
| 141 | |||
| 142 | =back | ||
| 143 | |||
| 144 | The default is C<FULLY_MUTABLE>. | ||
| 145 | |||
| 146 | Valid values are: C<"NON_PROVISIONABLE">, C<"IMMUTABLE">, C<"FULLY_MUTABLE"> | ||
| 147 | |||
| 148 | =head2 Type => Str | ||
| 149 | |||
| 150 | The type of extension. | ||
| 151 | |||
| 152 | Valid values are: C<"RESOURCE">, C<"MODULE"> | ||
| 153 | |||
| 154 | =head2 Visibility => Str | ||
| 155 | |||
| 156 | The scope at which the extensions are visible and usable in | ||
| 157 | CloudFormation operations. | ||
| 158 | |||
| 159 | Valid values include: | ||
| 160 | |||
| 161 | =over | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | C<PRIVATE>: Extensions that are visible and usable within this account | ||
| 166 | and region. This includes: | ||
| 167 | |||
| 168 | =over | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | Private extensions you have registered in this account and region. | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | Public extensions that you have activated in this account and region. | ||
| 177 | |||
| 178 | =back | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | C<PUBLIC>: Extensions that are publicly visible and available to be | ||
| 183 | activated within any Amazon account. This includes extensions from | ||
| 184 | Amazon, as well as third-party publishers. | ||
| 185 | |||
| 186 | =back | ||
| 187 | |||
| 188 | The default is C<PRIVATE>. | ||
| 189 | |||
| 190 | Valid values are: C<"PUBLIC">, C<"PRIVATE"> | ||
| 191 | |||
| 192 | |||
| 193 | =head1 SEE ALSO | ||
| 194 | |||
| 195 | This class forms part of L<Paws>, documenting arguments for method ListTypes in L<Paws::CloudFormation> | ||
| 196 | |||
| 197 | =head1 BUGS and CONTRIBUTIONS | ||
| 198 | |||
| 199 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 200 | |||
| 201 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 202 | |||
| 203 | =cut | ||
| 204 |