Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
Synopsis
- data DescribeTemplateDefinition = DescribeTemplateDefinition' {}
- newDescribeTemplateDefinition :: Text -> Text -> DescribeTemplateDefinition
- describeTemplateDefinition_aliasName :: Lens' DescribeTemplateDefinition (Maybe Text)
- describeTemplateDefinition_versionNumber :: Lens' DescribeTemplateDefinition (Maybe Natural)
- describeTemplateDefinition_awsAccountId :: Lens' DescribeTemplateDefinition Text
- describeTemplateDefinition_templateId :: Lens' DescribeTemplateDefinition Text
- data DescribeTemplateDefinitionResponse = DescribeTemplateDefinitionResponse' {}
- newDescribeTemplateDefinitionResponse :: Int -> DescribeTemplateDefinitionResponse
- describeTemplateDefinitionResponse_definition :: Lens' DescribeTemplateDefinitionResponse (Maybe TemplateVersionDefinition)
- describeTemplateDefinitionResponse_errors :: Lens' DescribeTemplateDefinitionResponse (Maybe (NonEmpty TemplateError))
- describeTemplateDefinitionResponse_name :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
- describeTemplateDefinitionResponse_requestId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
- describeTemplateDefinitionResponse_resourceStatus :: Lens' DescribeTemplateDefinitionResponse (Maybe ResourceStatus)
- describeTemplateDefinitionResponse_templateId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
- describeTemplateDefinitionResponse_themeArn :: Lens' DescribeTemplateDefinitionResponse (Maybe Text)
- describeTemplateDefinitionResponse_status :: Lens' DescribeTemplateDefinitionResponse Int
Creating a Request
data DescribeTemplateDefinition Source #
See: newDescribeTemplateDefinition
smart constructor.
DescribeTemplateDefinition' | |
|
Instances
newDescribeTemplateDefinition Source #
Create a value of DescribeTemplateDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTemplateDefinition
, describeTemplateDefinition_aliasName
- The alias of the template that you want to describe. If you name a
specific alias, you describe the version that the alias points to. You
can specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to templates.
DescribeTemplateDefinition
, describeTemplateDefinition_versionNumber
- The version number of the template.
DescribeTemplateDefinition
, describeTemplateDefinition_awsAccountId
- The ID of the Amazon Web Services account that contains the template.
You must be using the Amazon Web Services account that the template is
in.
DescribeTemplateDefinition
, describeTemplateDefinition_templateId
- The ID of the template that you're describing.
Request Lenses
describeTemplateDefinition_aliasName :: Lens' DescribeTemplateDefinition (Maybe Text) Source #
The alias of the template that you want to describe. If you name a
specific alias, you describe the version that the alias points to. You
can specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to templates.
describeTemplateDefinition_versionNumber :: Lens' DescribeTemplateDefinition (Maybe Natural) Source #
The version number of the template.
describeTemplateDefinition_awsAccountId :: Lens' DescribeTemplateDefinition Text Source #
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
describeTemplateDefinition_templateId :: Lens' DescribeTemplateDefinition Text Source #
The ID of the template that you're describing.
Destructuring the Response
data DescribeTemplateDefinitionResponse Source #
See: newDescribeTemplateDefinitionResponse
smart constructor.
DescribeTemplateDefinitionResponse' | |
|
Instances
newDescribeTemplateDefinitionResponse Source #
Create a value of DescribeTemplateDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:definition:DescribeTemplateDefinitionResponse'
, describeTemplateDefinitionResponse_definition
- The definition of the template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
DescribeTemplateDefinitionResponse
, describeTemplateDefinitionResponse_errors
- Errors associated with the template version.
DescribeTemplateDefinitionResponse
, describeTemplateDefinitionResponse_name
- The descriptive name of the template.
$sel:requestId:DescribeTemplateDefinitionResponse'
, describeTemplateDefinitionResponse_requestId
- The Amazon Web Services request ID for this operation.
$sel:resourceStatus:DescribeTemplateDefinitionResponse'
, describeTemplateDefinitionResponse_resourceStatus
- Status associated with the template.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
DescribeTemplateDefinition
, describeTemplateDefinitionResponse_templateId
- The ID of the template described.
DescribeTemplateDefinitionResponse
, describeTemplateDefinitionResponse_themeArn
- The ARN of the theme of the template.
DescribeTemplateDefinitionResponse
, describeTemplateDefinitionResponse_status
- The HTTP status of the request.
Response Lenses
describeTemplateDefinitionResponse_definition :: Lens' DescribeTemplateDefinitionResponse (Maybe TemplateVersionDefinition) Source #
The definition of the template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
describeTemplateDefinitionResponse_errors :: Lens' DescribeTemplateDefinitionResponse (Maybe (NonEmpty TemplateError)) Source #
Errors associated with the template version.
describeTemplateDefinitionResponse_name :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #
The descriptive name of the template.
describeTemplateDefinitionResponse_requestId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
describeTemplateDefinitionResponse_resourceStatus :: Lens' DescribeTemplateDefinitionResponse (Maybe ResourceStatus) Source #
Status associated with the template.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
describeTemplateDefinitionResponse_templateId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #
The ID of the template described.
describeTemplateDefinitionResponse_themeArn :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #
The ARN of the theme of the template.
describeTemplateDefinitionResponse_status :: Lens' DescribeTemplateDefinitionResponse Int Source #
The HTTP status of the request.