describe_domain

SWF.Client.describe_domain(**kwargs)

Returns information about the specified domain, including description and status.

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.
• 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 .

See also: AWS API Documentation

Request Syntax

response = client.describe_domain(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the domain to describe.

Return type

dict

Returns

Response Syntax

{
    'domainInfo': {
        'name': 'string',
        'status': 'REGISTERED'|'DEPRECATED',
        'description': 'string',
        'arn': 'string'
    },
    'configuration': {
        'workflowExecutionRetentionPeriodInDays': 'string'
    }
}

Response Structure

• (dict) --

  Contains details of a domain.

  • domainInfo (dict) --

    The basic information about a domain, such as its name, status, and description.

    • name (string) --

      The name of the domain. This name is unique within the account.

    • status (string) --

      The status of the domain:

      • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
      • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.
    • description (string) --

      The description of the domain provided through RegisterDomain.

    • arn (string) --

      The ARN of the domain.

  • configuration (dict) --

    The domain configuration. Currently, this includes only the domain's retention period.

    • workflowExecutionRetentionPeriodInDays (string) --

      The retention period for workflow executions in this domain.

Exceptions

• SWF.Client.exceptions.UnknownResourceFault
• SWF.Client.exceptions.OperationNotPermittedFault