Amazonka.CloudFormation.GetTemplateSummary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Creating a Request

data GetTemplateSummary

The input for the GetTemplateSummary action.

See: newGetTemplateSummary smart constructor.

Constructors

GetTemplateSummary'

Fields

• callAs :: Maybe CallAs

  Service-managed permissions

  Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

  By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

• stackName :: Maybe Text

  The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

  Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

• stackSetName :: Maybe Text

  The name or unique ID of the stack set from which the stack was created.

  Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

• templateBody :: Maybe Text

  Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

  Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

• templateURL :: Maybe Text

  Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide.

  Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Instances

ToHeaders GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

toHeaders :: GetTemplateSummary -> [Header]

ToPath GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

toPath :: GetTemplateSummary -> ByteString

ToQuery GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

toQuery :: GetTemplateSummary -> QueryString

AWSRequest GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type AWSResponse GetTemplateSummary

Methods

request :: (Service -> Service) -> GetTemplateSummary -> Request GetTemplateSummary

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTemplateSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTemplateSummary)))

Generic GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummary :: Type -> Type

Methods

from :: GetTemplateSummary -> Rep GetTemplateSummary x

to :: Rep GetTemplateSummary x -> GetTemplateSummary

Read GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

readsPrec :: Int -> ReadS GetTemplateSummary

readList :: ReadS [GetTemplateSummary]

readPrec :: ReadPrec GetTemplateSummary

readListPrec :: ReadPrec [GetTemplateSummary]

Show GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

showsPrec :: Int -> GetTemplateSummary -> ShowS

show :: GetTemplateSummary -> String

showList :: [GetTemplateSummary] -> ShowS

NFData GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

rnf :: GetTemplateSummary -> ()

Eq GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

(==) :: GetTemplateSummary -> GetTemplateSummary -> Bool

(/=) :: GetTemplateSummary -> GetTemplateSummary -> Bool

Hashable GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

hashWithSalt :: Int -> GetTemplateSummary -> Int

hash :: GetTemplateSummary -> Int

type AWSResponse GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

type AWSResponse GetTemplateSummary = GetTemplateSummaryResponse

type Rep GetTemplateSummary

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummary = D1 ('MetaData "GetTemplateSummary" "Amazonka.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "GetTemplateSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGetTemplateSummary :: GetTemplateSummary

Create a value of GetTemplateSummary 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:callAs:GetTemplateSummary', getTemplateSummary_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

GetTemplateSummary, getTemplateSummary_stackName - The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

GetTemplateSummary, getTemplateSummary_stackSetName - The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

GetTemplateSummary, getTemplateSummary_templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

$sel:templateURL:GetTemplateSummary', getTemplateSummary_templateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Request Lenses

getTemplateSummary_callAs :: Lens' GetTemplateSummary (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

getTemplateSummary_stackName :: Lens' GetTemplateSummary (Maybe Text)

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummary_stackSetName :: Lens' GetTemplateSummary (Maybe Text)

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummary_templateBody :: Lens' GetTemplateSummary (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

getTemplateSummary_templateURL :: Lens' GetTemplateSummary (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Destructuring the Response

data GetTemplateSummaryResponse

The output for the GetTemplateSummary action.

See: newGetTemplateSummaryResponse smart constructor.

Constructors

GetTemplateSummaryResponse'

Fields

• capabilities :: Maybe [Capability]

  The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• capabilitiesReason :: Maybe Text

  The list of resources that generated the values in the Capabilities response element.

• declaredTransforms :: Maybe [Text]

  A list of the transforms that are declared in the template.

• description :: Maybe Text

  The value that's defined in the Description property of the template.

• metadata :: Maybe Text

  The value that's defined for the Metadata property of the template.

• parameters :: Maybe [ParameterDeclaration]

  A list of parameter declarations that describe various properties for each parameter.

• resourceIdentifierSummaries :: Maybe [ResourceIdentifierSummary]

  A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

• resourceTypes :: Maybe [Text]

  A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

• version :: Maybe Text

  The Amazon Web Services template format version, which identifies the capabilities of the template.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummaryResponse :: Type -> Type

Methods

from :: GetTemplateSummaryResponse -> Rep GetTemplateSummaryResponse x

to :: Rep GetTemplateSummaryResponse x -> GetTemplateSummaryResponse

Read GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

readsPrec :: Int -> ReadS GetTemplateSummaryResponse

readList :: ReadS [GetTemplateSummaryResponse]

readPrec :: ReadPrec GetTemplateSummaryResponse

readListPrec :: ReadPrec [GetTemplateSummaryResponse]

Show GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

showsPrec :: Int -> GetTemplateSummaryResponse -> ShowS

show :: GetTemplateSummaryResponse -> String

showList :: [GetTemplateSummaryResponse] -> ShowS

NFData GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

rnf :: GetTemplateSummaryResponse -> ()

Eq GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

Methods

(==) :: GetTemplateSummaryResponse -> GetTemplateSummaryResponse -> Bool

(/=) :: GetTemplateSummaryResponse -> GetTemplateSummaryResponse -> Bool

type Rep GetTemplateSummaryResponse

Defined in Amazonka.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummaryResponse = D1 ('MetaData "GetTemplateSummaryResponse" "Amazonka.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "GetTemplateSummaryResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :*: S1 ('MetaSel ('Just "capabilitiesReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "declaredTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterDeclaration])) :*: S1 ('MetaSel ('Just "resourceIdentifierSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceIdentifierSummary]))) :*: (S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetTemplateSummaryResponse

Arguments

:: Int

$sel:httpStatus:GetTemplateSummaryResponse'

-> GetTemplateSummaryResponse

Create a value of GetTemplateSummaryResponse 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:

GetTemplateSummaryResponse, getTemplateSummaryResponse_capabilities - The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

$sel:capabilitiesReason:GetTemplateSummaryResponse', getTemplateSummaryResponse_capabilitiesReason - The list of resources that generated the values in the Capabilities response element.

$sel:declaredTransforms:GetTemplateSummaryResponse', getTemplateSummaryResponse_declaredTransforms - A list of the transforms that are declared in the template.

GetTemplateSummaryResponse, getTemplateSummaryResponse_description - The value that's defined in the Description property of the template.

GetTemplateSummaryResponse, getTemplateSummaryResponse_metadata - The value that's defined for the Metadata property of the template.

GetTemplateSummaryResponse, getTemplateSummaryResponse_parameters - A list of parameter declarations that describe various properties for each parameter.

$sel:resourceIdentifierSummaries:GetTemplateSummaryResponse', getTemplateSummaryResponse_resourceIdentifierSummaries - A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

$sel:resourceTypes:GetTemplateSummaryResponse', getTemplateSummaryResponse_resourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

$sel:version:GetTemplateSummaryResponse', getTemplateSummaryResponse_version - The Amazon Web Services template format version, which identifies the capabilities of the template.

$sel:httpStatus:GetTemplateSummaryResponse', getTemplateSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getTemplateSummaryResponse_capabilities :: Lens' GetTemplateSummaryResponse (Maybe [Capability])

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

getTemplateSummaryResponse_capabilitiesReason :: Lens' GetTemplateSummaryResponse (Maybe Text)

The list of resources that generated the values in the Capabilities response element.

getTemplateSummaryResponse_declaredTransforms :: Lens' GetTemplateSummaryResponse (Maybe [Text])

A list of the transforms that are declared in the template.

getTemplateSummaryResponse_description :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that's defined in the Description property of the template.

getTemplateSummaryResponse_metadata :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that's defined for the Metadata property of the template.

getTemplateSummaryResponse_parameters :: Lens' GetTemplateSummaryResponse (Maybe [ParameterDeclaration])

A list of parameter declarations that describe various properties for each parameter.

getTemplateSummaryResponse_resourceIdentifierSummaries :: Lens' GetTemplateSummaryResponse (Maybe [ResourceIdentifierSummary])

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

getTemplateSummaryResponse_resourceTypes :: Lens' GetTemplateSummaryResponse (Maybe [Text])

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

getTemplateSummaryResponse_version :: Lens' GetTemplateSummaryResponse (Maybe Text)

The Amazon Web Services template format version, which identifies the capabilities of the template.

getTemplateSummaryResponse_httpStatus :: Lens' GetTemplateSummaryResponse Int

The response's http status code.