Package software.amazon.awssdk.services.account.model

Interface ListRegionsRequest.Builder

All Superinterfaces:
AccountRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<ListRegionsRequest.Builder,ListRegionsRequest>, SdkBuilder<ListRegionsRequest.Builder,ListRegionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListRegionsRequest
public static interface ListRegionsRequest.Builder extends AccountRequest.Builder, SdkPojo, CopyableBuilder<ListRegionsRequest.Builder,ListRegionsRequest>

  • Method Details

    • accountId

      ListRegionsRequest.Builder accountId(String accountId)

      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

      Parameters:
      accountId - Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.

      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.

      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListRegionsRequest.Builder maxResults(Integer maxResults)

      The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      maxResults - The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListRegionsRequest.Builder nextToken(String nextToken)

      A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      nextToken - A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionOptStatusContainsWithStrings

      ListRegionsRequest.Builder regionOptStatusContainsWithStrings(Collection<String> regionOptStatusContains)

      A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

      Parameters:
      regionOptStatusContains - A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionOptStatusContainsWithStrings

      ListRegionsRequest.Builder regionOptStatusContainsWithStrings(String... regionOptStatusContains)

      A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

      Parameters:
      regionOptStatusContains - A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionOptStatusContains

      ListRegionsRequest.Builder regionOptStatusContains(Collection<RegionOptStatus> regionOptStatusContains)

      A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

      Parameters:
      regionOptStatusContains - A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionOptStatusContains

      ListRegionsRequest.Builder regionOptStatusContains(RegionOptStatus... regionOptStatusContains)

      A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

      Parameters:
      regionOptStatusContains - A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListRegionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListRegionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.