OpsWorks / Client / get_hostname_suggestion

get_hostname_suggestion#

OpsWorks.Client.get_hostname_suggestion(**kwargs)#

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.get_hostname_suggestion(
    LayerId='string'
)
Parameters:

LayerId (string) –

[REQUIRED]

The layer ID.

Return type:

dict

Returns:

Response Syntax

{
    'LayerId': 'string',
    'Hostname': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a GetHostnameSuggestion request.

    • LayerId (string) –

      The layer ID.

    • Hostname (string) –

      The generated host name.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException