Amazon WorkMail

Lists the tags applied to an Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

rtype:

dict

returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Tags (list) --

    A list of tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) --

        The key of the tag.

      • Value (string) --

        The value of the tag.

Untags the specified tags from the specified Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The tag keys.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Applies the specified tags to the specified Amazon WorkMail organization resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN:

string

param ResourceARN:

[REQUIRED]

The resource ARN.

type Tags:

list

param Tags:

[REQUIRED]

The tag key-value pairs.

• (dict) --

  Describes a tag applied to a resource.

  • Key (string) -- [REQUIRED]

    The key of the tag.

  • Value (string) -- [REQUIRED]

    The value of the tag.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ARN': 'string'}

Provides more information regarding a given organization based on its identifier.

See also: AWS API Documentation

Request Syntax

client.describe_organization(
    OrganizationId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The identifier for the organization to be described.

rtype:

dict

returns:

Response Syntax

{
    'OrganizationId': 'string',
    'Alias': 'string',
    'State': 'string',
    'DirectoryId': 'string',
    'DirectoryType': 'string',
    'DefaultMailDomain': 'string',
    'CompletedDate': datetime(2015, 1, 1),
    'ErrorMessage': 'string',
    'ARN': 'string'
}

Response Structure

• (dict) --

  • OrganizationId (string) --

    The identifier of an organization.

  • Alias (string) --

    The alias for an organization.

  • State (string) --

    The state of an organization.

  • DirectoryId (string) --

    The identifier for the directory associated with an Amazon WorkMail organization.

  • DirectoryType (string) --

    The type of directory associated with the WorkMail organization.

  • DefaultMailDomain (string) --

    The default mail domain associated with the organization.

  • CompletedDate (datetime) --

    The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

  • ErrorMessage (string) --

    (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

  • ARN (string) --

    The Amazon Resource Name (ARN) of the organization.