Lightsail / Client / get_active_names

get_active_names#

Lightsail.Client.get_active_names(**kwargs)#

Returns the names of all active (not deleted) resources.

Request Syntax

response = client.get_active_names(
    pageToken='string'
)

Parameters:

pageToken (string) –

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Return type:

dict

Returns:

Response Syntax

{
    'activeNames': [
        'string',
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- activeNames (list) –
  
  The list of active names returned by the get active names request.
  - (string) –
- nextPageToken (string) –
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.AccountSetupInProgressException
Lightsail.Client.exceptions.UnauthenticatedException