Skip to content

List Domains

swf_list_domains R Documentation

Returns the list of domains registered in the account

Description

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to ⁠arn:aws:swf::AccountID:domain/*⁠, where AccountID is the account ID, with no dashes.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Usage

swf_list_domains(nextPageToken, registrationStatus, maximumPageSize,
  reverseOrder)

Arguments

nextPageToken

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "⁠Specified token has exceeded its maximum lifetime⁠".

The configured maximumPageSize determines how many results can be returned in a single call.

registrationStatus

[required] Specifies the registration status of the domains to list.

maximumPageSize

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

reverseOrder

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Value

A list with the following syntax: 

list(
  domainInfos = list(
    list(
      name = "string",
      status = "REGISTERED"|"DEPRECATED",
      description = "string",
      arn = "string"
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$list_domains(
  nextPageToken = "string",
  registrationStatus = "REGISTERED"|"DEPRECATED",
  maximumPageSize = 123,
  reverseOrder = TRUE|FALSE
)