Class ListPermissionsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final IntegerSpecifies the total number of results that you want included on each page of the response.final StringSpecifies that you want to receive the next page of results.final PermissionStatusSpecifies that you want to filter the results to include only permissions with the specified status.final StringSpecifies that you want to filter the results to include only permissions with the specified status.final PermissionTypeFilterSpecifies that you want to list only permissions of this type:final StringSpecifies that you want to list only permissions of this type:final ResourceOwnerSpecifies that you want to list only permissions owned by a specific entity:final StringSpecifies that you want to list only permissions owned by a specific entity:final StringSpecifies that you want to list only those permissions that apply to the specified resource type.static Class<? extends ListPermissionsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceType
Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.
For example, to list only permissions that apply to Amazon EC2 subnets, specify
ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.- Returns:
- Specifies that you want to list only those permissions that apply to the specified resource type. This
parameter is not case sensitive.
For example, to list only permissions that apply to Amazon EC2 subnets, specify
ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.
-
resourceOwner
Specifies that you want to list only permissions owned by a specific entity:
-
SELF– returns only permissions owned by the calling account. -
OTHER-ACCOUNTS– returns only permissions shared with the calling account by other accounts.
If the service returns an enum value that is not available in the current SDK version,
resourceOwnerwill returnResourceOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceOwnerAsString().- Returns:
- Specifies that you want to list only permissions owned by a specific entity:
-
SELF– returns only permissions owned by the calling account. -
OTHER-ACCOUNTS– returns only permissions shared with the calling account by other accounts.
-
- See Also:
-
-
resourceOwnerAsString
Specifies that you want to list only permissions owned by a specific entity:
-
SELF– returns only permissions owned by the calling account. -
OTHER-ACCOUNTS– returns only permissions shared with the calling account by other accounts.
If the service returns an enum value that is not available in the current SDK version,
resourceOwnerwill returnResourceOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceOwnerAsString().- Returns:
- Specifies that you want to list only permissions owned by a specific entity:
-
SELF– returns only permissions owned by the calling account. -
OTHER-ACCOUNTS– returns only permissions shared with the calling account by other accounts.
-
- See Also:
-
-
nextToken
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'sNextTokenresponse to request the next page of results.- Returns:
- Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'sNextTokenresponse to request the next page of results.
-
maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.- Returns:
- Specifies the total number of results that you want included on each page of the response. If you do not
include this parameter, it defaults to a value that is specific to the operation. If additional items
exist beyond the number you specify, the
NextTokenresponse element is returned with a value (not null). Include the specified value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.
-
permissionType
Specifies that you want to list only permissions of this type:
-
AWS– returns only Amazon Web Services managed permissions. -
LOCAL– returns only customer managed permissions -
ALL– returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is
All.If the service returns an enum value that is not available in the current SDK version,
permissionTypewill returnPermissionTypeFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionTypeAsString().- Returns:
- Specifies that you want to list only permissions of this type:
-
AWS– returns only Amazon Web Services managed permissions. -
LOCAL– returns only customer managed permissions -
ALL– returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is
All. -
- See Also:
-
-
permissionTypeAsString
Specifies that you want to list only permissions of this type:
-
AWS– returns only Amazon Web Services managed permissions. -
LOCAL– returns only customer managed permissions -
ALL– returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is
All.If the service returns an enum value that is not available in the current SDK version,
permissionTypewill returnPermissionTypeFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionTypeAsString().- Returns:
- Specifies that you want to list only permissions of this type:
-
AWS– returns only Amazon Web Services managed permissions. -
LOCAL– returns only customer managed permissions -
ALL– returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is
All. -
- See Also:
-
-
permissionStatus
Specifies that you want to filter the results to include only permissions with the specified status. For example, use
ATTACHABLEto list only permissions that can be associated with resource shares, orDEPRECATEDto list only deprecated permissions.If the service returns an enum value that is not available in the current SDK version,
permissionStatuswill returnPermissionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionStatusAsString().- Returns:
- Specifies that you want to filter the results to include only permissions with the specified status. For
example, use
ATTACHABLEto list only permissions that can be associated with resource shares, orDEPRECATEDto list only deprecated permissions. - See Also:
-
permissionStatusAsString
Specifies that you want to filter the results to include only permissions with the specified status. For example, use
ATTACHABLEto list only permissions that can be associated with resource shares, orDEPRECATEDto list only deprecated permissions.If the service returns an enum value that is not available in the current SDK version,
permissionStatuswill returnPermissionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionStatusAsString().- Returns:
- Specifies that you want to filter the results to include only permissions with the specified status. For
example, use
ATTACHABLEto list only permissions that can be associated with resource shares, orDEPRECATEDto list only deprecated permissions. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListPermissionsRequest.Builder,ListPermissionsRequest> - Specified by:
toBuilderin classRamRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-