@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS OpsWorks
@version 2013-02-18
@auth AWS SigV4
@endpoints 74
@hint download_for_search
@toc root(74)

@endpoint POST /
@required {InstanceId: str, LayerIds: [str]}

@endpoint POST /
@required {VolumeId: str}
@optional {InstanceId: str}

@endpoint POST /
@required {ElasticIp: str}
@optional {InstanceId: str}

@endpoint POST /
@required {ElasticLoadBalancerName: str, LayerId: str}

@endpoint POST /
@required {SourceStackId: str, ServiceRoleArn: str}
@optional {Name: str, Region: str, VpcId: str, Attributes: map<str,str>, DefaultInstanceProfileArn: str, DefaultOs: str, HostnameTheme: str, DefaultAvailabilityZone: str, DefaultSubnetId: str, CustomJson: str, ConfigurationManager: StackConfigurationManager, ChefConfiguration: ChefConfiguration, UseCustomCookbooks: bool, UseOpsworksSecurityGroups: bool, CustomCookbooksSource: Source, DefaultSshKeyName: str, ClonePermissions: bool, CloneAppIds: [str], DefaultRootDeviceType: str, AgentVersion: str}
@returns(200) {StackId: str?}

@endpoint POST /
@required {StackId: str, Name: str, Type: str}
@optional {Shortname: str, Description: str, DataSources: [DataSource], AppSource: Source, Domains: [str], EnableSsl: bool, SslConfiguration: SslConfiguration, Attributes: map<str,str>, Environment: [EnvironmentVariable]}
@returns(200) {AppId: str?}

@endpoint POST /
@required {StackId: str, Command: DeploymentCommand}
@optional {AppId: str, InstanceIds: [str], LayerIds: [str], Comment: str, CustomJson: str}
@returns(200) {DeploymentId: str?}

@endpoint POST /
@required {StackId: str, LayerIds: [str], InstanceType: str}
@optional {AutoScalingType: str, Hostname: str, Os: str, AmiId: str, SshKeyName: str, AvailabilityZone: str, VirtualizationType: str, SubnetId: str, Architecture: str, RootDeviceType: str, BlockDeviceMappings: [BlockDeviceMapping], InstallUpdatesOnBoot: bool, EbsOptimized: bool, AgentVersion: str, Tenancy: str}
@returns(200) {InstanceId: str?}

@endpoint POST /
@required {StackId: str, Type: str, Name: str, Shortname: str}
@optional {Attributes: map<str,str>, CloudWatchLogsConfiguration: CloudWatchLogsConfiguration, CustomInstanceProfileArn: str, CustomJson: str, CustomSecurityGroupIds: [str], Packages: [str], VolumeConfigurations: [VolumeConfiguration], EnableAutoHealing: bool, AutoAssignElasticIps: bool, AutoAssignPublicIps: bool, CustomRecipes: Recipes, InstallUpdatesOnBoot: bool, UseEbsOptimizedInstances: bool, LifecycleEventConfiguration: LifecycleEventConfiguration}
@returns(200) {LayerId: str?}

@endpoint POST /
@required {Name: str, Region: str, ServiceRoleArn: str, DefaultInstanceProfileArn: str}
@optional {VpcId: str, Attributes: map<str,str>, DefaultOs: str, HostnameTheme: str, DefaultAvailabilityZone: str, DefaultSubnetId: str, CustomJson: str, ConfigurationManager: StackConfigurationManager, ChefConfiguration: ChefConfiguration, UseCustomCookbooks: bool, UseOpsworksSecurityGroups: bool, CustomCookbooksSource: Source, DefaultSshKeyName: str, DefaultRootDeviceType: str, AgentVersion: str}
@returns(200) {StackId: str?}

@endpoint POST /
@required {IamUserArn: str}
@optional {SshUsername: str, SshPublicKey: str, AllowSelfManagement: bool}
@returns(200) {IamUserArn: str?}

@endpoint POST /
@required {AppId: str}

@endpoint POST /
@required {InstanceId: str}
@optional {DeleteElasticIp: bool, DeleteVolumes: bool}

@endpoint POST /
@required {LayerId: str}

@endpoint POST /
@required {StackId: str}

@endpoint POST /
@required {IamUserArn: str}

@endpoint POST /
@required {EcsClusterArn: str}

@endpoint POST /
@required {ElasticIp: str}

@endpoint POST /
@required {InstanceId: str}

@endpoint POST /
@required {RdsDbInstanceArn: str}

@endpoint POST /
@required {VolumeId: str}

@endpoint POST /
@optional {StackId: str, ConfigurationManager: StackConfigurationManager}
@returns(200) {AgentVersions: [AgentVersion]?}

@endpoint POST /
@optional {StackId: str, AppIds: [str]}
@returns(200) {Apps: [App]?}

@endpoint POST /
@optional {DeploymentId: str, InstanceId: str, CommandIds: [str]}
@returns(200) {Commands: [Command]?}

@endpoint POST /
@optional {StackId: str, AppId: str, DeploymentIds: [str]}
@returns(200) {Deployments: [Deployment]?}

@endpoint POST /
@optional {EcsClusterArns: [str], StackId: str, NextToken: str, MaxResults: int}
@returns(200) {EcsClusters: [EcsCluster]?, NextToken: str?}

@endpoint POST /
@optional {InstanceId: str, StackId: str, Ips: [str]}
@returns(200) {ElasticIps: [ElasticIp]?}

@endpoint POST /
@optional {StackId: str, LayerIds: [str]}
@returns(200) {ElasticLoadBalancers: [ElasticLoadBalancer]?}

@endpoint POST /
@optional {StackId: str, LayerId: str, InstanceIds: [str]}
@returns(200) {Instances: [Instance]?}

@endpoint POST /
@optional {StackId: str, LayerIds: [str]}
@returns(200) {Layers: [Layer]?}

@endpoint POST /
@required {LayerIds: [str]}
@returns(200) {LoadBasedAutoScalingConfigurations: [LoadBasedAutoScalingConfiguration]?}

@endpoint POST /
@returns(200) {UserProfile: SelfUserProfile?{IamUserArn: str?, Name: str?, SshUsername: str?, SshPublicKey: str?}}

@endpoint POST /
@returns(200) {OperatingSystems: [OperatingSystem]?}

@endpoint POST /
@optional {IamUserArn: str, StackId: str}
@returns(200) {Permissions: [Permission]?}

@endpoint POST /
@optional {InstanceId: str, StackId: str, RaidArrayIds: [str]}
@returns(200) {RaidArrays: [RaidArray]?}

@endpoint POST /
@required {StackId: str}
@optional {RdsDbInstanceArns: [str]}
@returns(200) {RdsDbInstances: [RdsDbInstance]?}

@endpoint POST /
@optional {StackId: str, InstanceId: str, ServiceErrorIds: [str]}
@returns(200) {ServiceErrors: [ServiceError]?}

@endpoint POST /
@required {StackId: str}
@returns(200) {AgentInstallerUrl: str?, Parameters: map<str,str>?}

@endpoint POST /
@required {StackId: str}
@returns(200) {StackSummary: StackSummary?{StackId: str?, Name: str?, Arn: str?, LayersCount: int?, AppsCount: int?, InstancesCount: InstancesCount?{Assigning: int?, Booting: int?, ConnectionLost: int?, Deregistering: int?, Online: int?, Pending: int?, Rebooting: int?, Registered: int?, Registering: int?, Requested: int?, RunningSetup: int?, SetupFailed: int?, ShuttingDown: int?, StartFailed: int?, StopFailed: int?, Stopped: int?, Stopping: int?, Terminated: int?, Terminating: int?, Unassigning: int?}}}

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

@endpoint POST /
@required {InstanceIds: [str]}
@returns(200) {TimeBasedAutoScalingConfigurations: [TimeBasedAutoScalingConfiguration]?}

@endpoint POST /
@optional {IamUserArns: [str]}
@returns(200) {UserProfiles: [UserProfile]?}

@endpoint POST /
@optional {InstanceId: str, StackId: str, RaidArrayId: str, VolumeIds: [str]}
@returns(200) {Volumes: [Volume]?}

@endpoint POST /
@required {ElasticLoadBalancerName: str, LayerId: str}

@endpoint POST /
@required {ElasticIp: str}

@endpoint POST /
@required {LayerId: str}
@returns(200) {LayerId: str?, Hostname: str?}

@endpoint POST /
@required {InstanceId: str}
@optional {ValidForInMinutes: int}
@returns(200) {TemporaryCredential: TemporaryCredential?{Username: str?, Password: str?, ValidForInMinutes: int?, InstanceId: str?}}

@endpoint POST /
@required {ResourceArn: str}
@optional {MaxResults: int, NextToken: str}
@returns(200) {Tags: map<str,str>?, NextToken: str?}

@endpoint POST /
@required {InstanceId: str}

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

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

@endpoint POST /
@required {StackId: str}
@optional {Hostname: str, PublicIp: str, PrivateIp: str, RsaPublicKey: str, RsaPublicKeyFingerprint: str, InstanceIdentity: InstanceIdentity}
@returns(200) {InstanceId: str?}

@endpoint POST /
@required {StackId: str, RdsDbInstanceArn: str, DbUser: str, DbPassword: str}

@endpoint POST /
@required {StackId: str}
@optional {Ec2VolumeId: str}
@returns(200) {VolumeId: str?}

@endpoint POST /
@required {LayerId: str}
@optional {Enable: bool, UpScaling: AutoScalingThresholds, DownScaling: AutoScalingThresholds}

@endpoint POST /
@required {StackId: str, IamUserArn: str}
@optional {AllowSsh: bool, AllowSudo: bool, Level: str}

@endpoint POST /
@required {InstanceId: str}
@optional {AutoScalingSchedule: WeeklyAutoScalingSchedule}

@endpoint POST /
@required {InstanceId: str}

@endpoint POST /
@required {StackId: str}

@endpoint POST /
@required {InstanceId: str}
@optional {Force: bool}

@endpoint POST /
@required {StackId: str}

@endpoint POST /
@required {ResourceArn: str, Tags: map<str,str>}

@endpoint POST /
@required {InstanceId: str}

@endpoint POST /
@required {VolumeId: str}

@endpoint POST /
@required {ResourceArn: str, TagKeys: [str]}

@endpoint POST /
@required {AppId: str}
@optional {Name: str, Description: str, DataSources: [DataSource], Type: str, AppSource: Source, Domains: [str], EnableSsl: bool, SslConfiguration: SslConfiguration, Attributes: map<str,str>, Environment: [EnvironmentVariable]}

@endpoint POST /
@required {ElasticIp: str}
@optional {Name: str}

@endpoint POST /
@required {InstanceId: str}
@optional {LayerIds: [str], InstanceType: str, AutoScalingType: str, Hostname: str, Os: str, AmiId: str, SshKeyName: str, Architecture: str, InstallUpdatesOnBoot: bool, EbsOptimized: bool, AgentVersion: str}

@endpoint POST /
@required {LayerId: str}
@optional {Name: str, Shortname: str, Attributes: map<str,str>, CloudWatchLogsConfiguration: CloudWatchLogsConfiguration, CustomInstanceProfileArn: str, CustomJson: str, CustomSecurityGroupIds: [str], Packages: [str], VolumeConfigurations: [VolumeConfiguration], EnableAutoHealing: bool, AutoAssignElasticIps: bool, AutoAssignPublicIps: bool, CustomRecipes: Recipes, InstallUpdatesOnBoot: bool, UseEbsOptimizedInstances: bool, LifecycleEventConfiguration: LifecycleEventConfiguration}

@endpoint POST /
@optional {SshPublicKey: str}

@endpoint POST /
@required {RdsDbInstanceArn: str}
@optional {DbUser: str, DbPassword: str}

@endpoint POST /
@required {StackId: str}
@optional {Name: str, Attributes: map<str,str>, ServiceRoleArn: str, DefaultInstanceProfileArn: str, DefaultOs: str, HostnameTheme: str, DefaultAvailabilityZone: str, DefaultSubnetId: str, CustomJson: str, ConfigurationManager: StackConfigurationManager, ChefConfiguration: ChefConfiguration, UseCustomCookbooks: bool, CustomCookbooksSource: Source, DefaultSshKeyName: str, DefaultRootDeviceType: str, UseOpsworksSecurityGroups: bool, AgentVersion: str}

@endpoint POST /
@required {IamUserArn: str}
@optional {SshUsername: str, SshPublicKey: str, AllowSelfManagement: bool}

@endpoint POST /
@required {VolumeId: str}
@optional {Name: str, MountPoint: str}

@end