@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS CloudFormation
@version 2010-05-15
@auth AWS SigV4
@endpoints 82
@hint download_for_search
@toc root(82)

@endpoint POST /

@endpoint POST /
@optional {Type: str, PublicTypeArn: str, PublisherId: str, TypeName: str, TypeNameAlias: str, AutoUpdate: bool, LoggingConfig: LoggingConfig, ExecutionRoleArn: str, VersionBump: str, MajorVersion: int(i64)}
@returns(200) {Arn: str?}

@endpoint POST /
@required {TypeConfigurationIdentifiers: [TypeConfigurationIdentifier]}
@returns(200) {Errors: [BatchDescribeTypeConfigurationsError]?, UnprocessedTypeConfigurations: [TypeConfigurationIdentifier]?, TypeConfigurations: [TypeConfigurationDetails]?}

@endpoint POST /
@required {StackName: str}
@optional {ClientRequestToken: str}

@endpoint POST /
@required {StackName: str}
@optional {RoleARN: str, ResourcesToSkip: [str], ClientRequestToken: str}

@endpoint POST /
@required {StackName: str, ChangeSetName: str}
@optional {TemplateBody: str, TemplateURL: str, UsePreviousTemplate: bool, Parameters: [Parameter], Capabilities: [str], ResourceTypes: [str], RoleARN: str, RollbackConfiguration: RollbackConfiguration, NotificationARNs: [str], Tags: [Tag], ClientToken: str, Description: str, ChangeSetType: str, ResourcesToImport: [ResourceToImport], IncludeNestedStacks: bool, OnStackFailure: str, ImportExistingResources: bool}
@returns(200) {Id: str?, StackId: str?}

@endpoint POST /
@required {GeneratedTemplateName: str}
@optional {Resources: [ResourceDefinition], StackName: str, TemplateConfiguration: TemplateConfiguration}
@returns(200) {GeneratedTemplateId: str?}

@endpoint POST /
@required {StackName: str}
@optional {TemplateBody: str, TemplateURL: str, Parameters: [Parameter], DisableRollback: bool, RollbackConfiguration: RollbackConfiguration, TimeoutInMinutes: int, NotificationARNs: [str], Capabilities: [str], ResourceTypes: [str], RoleARN: str, OnFailure: str, StackPolicyBody: str, StackPolicyURL: str, Tags: [Tag], ClientRequestToken: str, EnableTerminationProtection: bool, RetainExceptOnCreate: bool}
@returns(200) {StackId: str?}

@endpoint POST /
@required {StackSetName: str, Regions: [str]}
@optional {Accounts: [str], DeploymentTargets: DeploymentTargets, ParameterOverrides: [Parameter], OperationPreferences: StackSetOperationPreferences, OperationId: str, CallAs: str}
@returns(200) {OperationId: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {Description: str, TemplateBody: str, TemplateURL: str, StackId: str, Parameters: [Parameter], Capabilities: [str], Tags: [Tag], AdministrationRoleARN: str, ExecutionRoleName: str, PermissionModel: str, AutoDeployment: AutoDeployment, CallAs: str, ClientRequestToken: str, ManagedExecution: ManagedExecution}
@returns(200) {StackSetId: str?}

@endpoint POST /

@endpoint POST /
@optional {TypeName: str, Type: str, Arn: str}

@endpoint POST /
@required {ChangeSetName: str}
@optional {StackName: str}

@endpoint POST /
@required {GeneratedTemplateName: str}

@endpoint POST /
@required {StackName: str}
@optional {RetainResources: [str], RoleARN: str, ClientRequestToken: str, DeletionMode: str}

@endpoint POST /
@required {StackSetName: str, Regions: [str], RetainStacks: bool}
@optional {Accounts: [str], DeploymentTargets: DeploymentTargets, OperationPreferences: StackSetOperationPreferences, OperationId: str, CallAs: str}
@returns(200) {OperationId: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {CallAs: str}

@endpoint POST /
@optional {Arn: str, Type: str, TypeName: str, VersionId: str}

@endpoint POST /
@optional {NextToken: str}
@returns(200) {AccountLimits: [AccountLimit]?, NextToken: str?}

@endpoint POST /
@required {ChangeSetName: str}
@optional {StackName: str, NextToken: str, IncludePropertyValues: bool}
@returns(200) {ChangeSetName: str?, ChangeSetId: str?, StackId: str?, StackName: str?, Description: str?, Parameters: [Parameter]?, CreationTime: str(timestamp)?, ExecutionStatus: str?, Status: str?, StatusReason: str?, NotificationARNs: [str]?, RollbackConfiguration: RollbackConfiguration?{RollbackTriggers: [RollbackTrigger]?, MonitoringTimeInMinutes: int?}, Capabilities: [str]?, Tags: [Tag]?, Changes: [Change]?, NextToken: str?, IncludeNestedStacks: bool?, ParentChangeSetId: str?, RootChangeSetId: str?, OnStackFailure: str?, ImportExistingResources: bool?}

@endpoint POST /
@required {ChangeSetName: str}
@optional {StackName: str, NextToken: str, LogicalResourceId: str}
@returns(200) {ChangeSetId: str?, ChangeSetName: str?, Hooks: [ChangeSetHook]?, Status: str?, NextToken: str?, StackId: str?, StackName: str?}

@endpoint POST /
@required {GeneratedTemplateName: str}
@returns(200) {GeneratedTemplateId: str?, GeneratedTemplateName: str?, Resources: [ResourceDetail]?, Status: str?, StatusReason: str?, CreationTime: str(timestamp)?, LastUpdatedTime: str(timestamp)?, Progress: TemplateProgress?{ResourcesSucceeded: int?, ResourcesFailed: int?, ResourcesProcessing: int?, ResourcesPending: int?}, StackId: str?, TemplateConfiguration: TemplateConfiguration?{DeletionPolicy: str?, UpdateReplacePolicy: str?}, TotalWarnings: int?}

@endpoint POST /
@optional {CallAs: str}
@returns(200) {Status: str?}

@endpoint POST /
@optional {PublisherId: str}
@returns(200) {PublisherId: str?, PublisherStatus: str?, IdentityProvider: str?, PublisherProfile: str?}

@endpoint POST /
@required {ResourceScanId: str}
@returns(200) {ResourceScanId: str?, Status: str?, StatusReason: str?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, PercentageCompleted: num(f64)?, ResourceTypes: [str]?, ResourcesScanned: int?, ResourcesRead: int?}

@endpoint POST /
@required {StackDriftDetectionId: str}
@returns(200) {StackId: str, StackDriftDetectionId: str, StackDriftStatus: str?, DetectionStatus: str, DetectionStatusReason: str?, DriftedStackResourceCount: int?, Timestamp: str(timestamp)}

@endpoint POST /
@optional {StackName: str, NextToken: str}
@returns(200) {StackEvents: [StackEvent]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str, StackInstanceAccount: str, StackInstanceRegion: str}
@optional {CallAs: str}
@returns(200) {StackInstance: StackInstance?{StackSetId: str?, Region: str?, Account: str?, StackId: str?, ParameterOverrides: [Parameter]?, Status: str?, StackInstanceStatus: StackInstanceComprehensiveStatus?{DetailedStatus: str?}, StatusReason: str?, OrganizationalUnitId: str?, DriftStatus: str?, LastDriftCheckTimestamp: str(timestamp)?, LastOperationId: str?}}

@endpoint POST /
@required {StackName: str, LogicalResourceId: str}
@returns(200) {StackResourceDetail: StackResourceDetail?{StackName: str?, StackId: str?, LogicalResourceId: str, PhysicalResourceId: str?, ResourceType: str, LastUpdatedTimestamp: str(timestamp), ResourceStatus: str, ResourceStatusReason: str?, Description: str?, Metadata: str?, DriftInformation: StackResourceDriftInformation?{StackResourceDriftStatus: str, LastCheckTimestamp: str(timestamp)?}, ModuleInfo: ModuleInfo?{TypeHierarchy: str?, LogicalIdHierarchy: str?}}}

@endpoint POST /
@required {StackName: str}
@optional {StackResourceDriftStatusFilters: [str], NextToken: str, MaxResults: int}
@returns(200) {StackResourceDrifts: [StackResourceDrift], NextToken: str?}

@endpoint POST /
@optional {StackName: str, LogicalResourceId: str, PhysicalResourceId: str}
@returns(200) {StackResources: [StackResource]?}

@endpoint POST /
@required {StackSetName: str}
@optional {CallAs: str}
@returns(200) {StackSet: StackSet?{StackSetName: str?, StackSetId: str?, Description: str?, Status: str?, TemplateBody: str?, Parameters: [Parameter]?, Capabilities: [str]?, Tags: [Tag]?, StackSetARN: str?, AdministrationRoleARN: str?, ExecutionRoleName: str?, StackSetDriftDetectionDetails: StackSetDriftDetectionDetails?{DriftStatus: str?, DriftDetectionStatus: str?, LastDriftCheckTimestamp: str(timestamp)?, TotalStackInstancesCount: int?, DriftedStackInstancesCount: int?, InSyncStackInstancesCount: int?, InProgressStackInstancesCount: int?, FailedStackInstancesCount: int?}, AutoDeployment: AutoDeployment?{Enabled: bool?, RetainStacksOnAccountRemoval: bool?}, PermissionModel: str?, OrganizationalUnitIds: [str]?, ManagedExecution: ManagedExecution?{Active: bool?}, Regions: [str]?}}

@endpoint POST /
@required {StackSetName: str, OperationId: str}
@optional {CallAs: str}
@returns(200) {StackSetOperation: StackSetOperation?{OperationId: str?, StackSetId: str?, Action: str?, Status: str?, OperationPreferences: StackSetOperationPreferences?{RegionConcurrencyType: str?, RegionOrder: [str]?, FailureToleranceCount: int?, FailureTolerancePercentage: int?, MaxConcurrentCount: int?, MaxConcurrentPercentage: int?, ConcurrencyMode: str?}, RetainStacks: bool?, AdministrationRoleARN: str?, ExecutionRoleName: str?, CreationTimestamp: str(timestamp)?, EndTimestamp: str(timestamp)?, DeploymentTargets: DeploymentTargets?{Accounts: [str]?, AccountsUrl: str?, OrganizationalUnitIds: [str]?, AccountFilterType: str?}, StackSetDriftDetectionDetails: StackSetDriftDetectionDetails?{DriftStatus: str?, DriftDetectionStatus: str?, LastDriftCheckTimestamp: str(timestamp)?, TotalStackInstancesCount: int?, DriftedStackInstancesCount: int?, InSyncStackInstancesCount: int?, InProgressStackInstancesCount: int?, FailedStackInstancesCount: int?}, StatusReason: str?, StatusDetails: StackSetOperationStatusDetails?{FailedStackInstancesCount: int?}}}

@endpoint POST /
@optional {StackName: str, NextToken: str}
@returns(200) {Stacks: [Stack]?, NextToken: str?}

@endpoint POST /
@optional {Type: str, TypeName: str, Arn: str, VersionId: str, PublisherId: str, PublicVersionNumber: str}
@returns(200) {Arn: str?, Type: str?, TypeName: str?, DefaultVersionId: str?, IsDefaultVersion: bool?, TypeTestsStatus: str?, TypeTestsStatusDescription: str?, Description: str?, Schema: str?, ProvisioningType: str?, DeprecatedStatus: str?, LoggingConfig: LoggingConfig?{LogRoleArn: str, LogGroupName: str}, RequiredActivatedTypes: [RequiredActivatedType]?, ExecutionRoleArn: str?, Visibility: str?, SourceUrl: str?, DocumentationUrl: str?, LastUpdated: str(timestamp)?, TimeCreated: str(timestamp)?, ConfigurationSchema: str?, PublisherId: str?, OriginalTypeName: str?, OriginalTypeArn: str?, PublicVersionNumber: str?, LatestPublicVersion: str?, IsActivated: bool?, AutoUpdate: bool?}

@endpoint POST /
@required {RegistrationToken: str}
@returns(200) {ProgressStatus: str?, Description: str?, TypeArn: str?, TypeVersionArn: str?}

@endpoint POST /
@required {StackName: str}
@optional {LogicalResourceIds: [str]}
@returns(200) {StackDriftDetectionId: str}

@endpoint POST /
@required {StackName: str, LogicalResourceId: str}
@returns(200) {StackResourceDrift: StackResourceDrift{StackId: str, LogicalResourceId: str, PhysicalResourceId: str?, PhysicalResourceIdContext: [PhysicalResourceIdContextKeyValuePair]?, ResourceType: str, ExpectedProperties: str?, ActualProperties: str?, PropertyDifferences: [PropertyDifference]?, StackResourceDriftStatus: str, Timestamp: str(timestamp), ModuleInfo: ModuleInfo?{TypeHierarchy: str?, LogicalIdHierarchy: str?}}}

@endpoint POST /
@required {StackSetName: str}
@optional {OperationPreferences: StackSetOperationPreferences, OperationId: str, CallAs: str}
@returns(200) {OperationId: str?}

@endpoint POST /
@optional {TemplateBody: str, TemplateURL: str, Parameters: [Parameter]}
@returns(200) {Url: str?}

@endpoint POST /
@required {ChangeSetName: str}
@optional {StackName: str, ClientRequestToken: str, DisableRollback: bool, RetainExceptOnCreate: bool}

@endpoint POST /
@required {GeneratedTemplateName: str}
@optional {Format: str}
@returns(200) {Status: str?, TemplateBody: str?}

@endpoint POST /
@required {StackName: str}
@returns(200) {StackPolicyBody: str?}

@endpoint POST /
@optional {StackName: str, ChangeSetName: str, TemplateStage: str}
@returns(200) {TemplateBody: str?, StagesAvailable: [str]?}

@endpoint POST /
@optional {TemplateBody: str, TemplateURL: str, StackName: str, StackSetName: str, CallAs: str, TemplateSummaryConfig: TemplateSummaryConfig}
@returns(200) {Parameters: [ParameterDeclaration]?, Description: str?, Capabilities: [str]?, CapabilitiesReason: str?, ResourceTypes: [str]?, Version: str?, Metadata: str?, DeclaredTransforms: [str]?, ResourceIdentifierSummaries: [ResourceIdentifierSummary]?, Warnings: Warnings?{UnrecognizedResourceTypes: [str]?}}

@endpoint POST /
@required {StackSetName: str}
@optional {StackIds: [str], StackIdsUrl: str, OrganizationalUnitIds: [str], OperationPreferences: StackSetOperationPreferences, OperationId: str, CallAs: str}
@returns(200) {OperationId: str?}

@endpoint POST /
@required {StackName: str}
@optional {NextToken: str}
@returns(200) {Summaries: [ChangeSetSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str}
@returns(200) {Exports: [Export]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int}
@returns(200) {Summaries: [TemplateSummary]?, NextToken: str?}

@endpoint POST /
@required {ExportName: str}
@optional {NextToken: str}
@returns(200) {Imports: [str]?, NextToken: str?}

@endpoint POST /
@required {ResourceScanId: str, Resources: [ScannedResourceIdentifier]}
@optional {NextToken: str, MaxResults: int}
@returns(200) {RelatedResources: [ScannedResource]?, NextToken: str?}

@endpoint POST /
@required {ResourceScanId: str}
@optional {ResourceIdentifier: str, ResourceTypePrefix: str, TagKey: str, TagValue: str, NextToken: str, MaxResults: int}
@returns(200) {Resources: [ScannedResource]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int}
@returns(200) {ResourceScanSummaries: [ResourceScanSummary]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str, StackInstanceAccount: str, StackInstanceRegion: str, OperationId: str}
@optional {NextToken: str, MaxResults: int, StackInstanceResourceDriftStatuses: [str], CallAs: str}
@returns(200) {Summaries: [StackInstanceResourceDriftsSummary]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {NextToken: str, MaxResults: int, Filters: [StackInstanceFilter], StackInstanceAccount: str, StackInstanceRegion: str, CallAs: str}
@returns(200) {Summaries: [StackInstanceSummary]?, NextToken: str?}

@endpoint POST /
@required {StackName: str}
@optional {NextToken: str}
@returns(200) {StackResourceSummaries: [StackResourceSummary]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {NextToken: str, MaxResults: int, CallAs: str}
@returns(200) {Summaries: [StackSetAutoDeploymentTargetSummary]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str, OperationId: str}
@optional {NextToken: str, MaxResults: int, CallAs: str, Filters: [OperationResultFilter]}
@returns(200) {Summaries: [StackSetOperationResultSummary]?, NextToken: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {NextToken: str, MaxResults: int, CallAs: str}
@returns(200) {Summaries: [StackSetOperationSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Status: str, CallAs: str}
@returns(200) {Summaries: [StackSetSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, StackStatusFilter: [str]}
@returns(200) {StackSummaries: [StackSummary]?, NextToken: str?}

@endpoint POST /
@optional {Type: str, TypeName: str, TypeArn: str, RegistrationStatusFilter: str, MaxResults: int, NextToken: str}
@returns(200) {RegistrationTokenList: [str]?, NextToken: str?}

@endpoint POST /
@optional {Type: str, TypeName: str, Arn: str, MaxResults: int, NextToken: str, DeprecatedStatus: str, PublisherId: str}
@returns(200) {TypeVersionSummaries: [TypeVersionSummary]?, NextToken: str?}

@endpoint POST /
@optional {Visibility: str, ProvisioningType: str, DeprecatedStatus: str, Type: str, Filters: TypeFilters, MaxResults: int, NextToken: str}
@returns(200) {TypeSummaries: [TypeSummary]?, NextToken: str?}

@endpoint POST /
@optional {Type: str, Arn: str, TypeName: str, PublicVersionNumber: str}
@returns(200) {PublicTypeArn: str?}

@endpoint POST /
@required {BearerToken: str, OperationStatus: str}
@optional {CurrentOperationStatus: str, StatusMessage: str, ErrorCode: str, ResourceModel: str, ClientRequestToken: str}

@endpoint POST /
@optional {AcceptTermsAndConditions: bool, ConnectionArn: str}
@returns(200) {PublisherId: str?}

@endpoint POST /
@required {TypeName: str, SchemaHandlerPackage: str}
@optional {Type: str, LoggingConfig: LoggingConfig, ExecutionRoleArn: str, ClientRequestToken: str}
@returns(200) {RegistrationToken: str?}

@endpoint POST /
@required {StackName: str}
@optional {RoleARN: str, ClientRequestToken: str, RetainExceptOnCreate: bool}
@returns(200) {StackId: str?}

@endpoint POST /
@required {StackName: str}
@optional {StackPolicyBody: str, StackPolicyURL: str}

@endpoint POST /
@required {Configuration: str}
@optional {TypeArn: str, ConfigurationAlias: str, TypeName: str, Type: str}
@returns(200) {ConfigurationArn: str?}

@endpoint POST /
@optional {Arn: str, Type: str, TypeName: str, VersionId: str}

@endpoint POST /
@required {StackName: str, LogicalResourceId: str, UniqueId: str, Status: str}

@endpoint POST /
@optional {ClientRequestToken: str}
@returns(200) {ResourceScanId: str?}

@endpoint POST /
@required {StackSetName: str, OperationId: str}
@optional {CallAs: str}

@endpoint POST /
@optional {Arn: str, Type: str, TypeName: str, VersionId: str, LogDeliveryBucket: str}
@returns(200) {TypeVersionArn: str?}

@endpoint POST /
@required {GeneratedTemplateName: str}
@optional {NewGeneratedTemplateName: str, AddResources: [ResourceDefinition], RemoveResources: [str], RefreshAllResources: bool, TemplateConfiguration: TemplateConfiguration}
@returns(200) {GeneratedTemplateId: str?}

@endpoint POST /
@required {StackName: str}
@optional {TemplateBody: str, TemplateURL: str, UsePreviousTemplate: bool, StackPolicyDuringUpdateBody: str, StackPolicyDuringUpdateURL: str, Parameters: [Parameter], Capabilities: [str], ResourceTypes: [str], RoleARN: str, RollbackConfiguration: RollbackConfiguration, StackPolicyBody: str, StackPolicyURL: str, NotificationARNs: [str], Tags: [Tag], DisableRollback: bool, ClientRequestToken: str, RetainExceptOnCreate: bool}
@returns(200) {StackId: str?}

@endpoint POST /
@required {StackSetName: str, Regions: [str]}
@optional {Accounts: [str], DeploymentTargets: DeploymentTargets, ParameterOverrides: [Parameter], OperationPreferences: StackSetOperationPreferences, OperationId: str, CallAs: str}
@returns(200) {OperationId: str?}

@endpoint POST /
@required {StackSetName: str}
@optional {Description: str, TemplateBody: str, TemplateURL: str, UsePreviousTemplate: bool, Parameters: [Parameter], Capabilities: [str], Tags: [Tag], OperationPreferences: StackSetOperationPreferences, AdministrationRoleARN: str, ExecutionRoleName: str, DeploymentTargets: DeploymentTargets, PermissionModel: str, AutoDeployment: AutoDeployment, OperationId: str, Accounts: [str], Regions: [str], CallAs: str, ManagedExecution: ManagedExecution}
@returns(200) {OperationId: str?}

@endpoint POST /
@required {EnableTerminationProtection: bool, StackName: str}
@returns(200) {StackId: str?}

@endpoint POST /
@optional {TemplateBody: str, TemplateURL: str}
@returns(200) {Parameters: [TemplateParameter]?, Description: str?, Capabilities: [str]?, CapabilitiesReason: str?, DeclaredTransforms: [str]?}

@end